OutlineProperties Class

Outline Properties.When the object is serialized out as xml, its qualified name is x:outlinePr.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Spreadsheet.OutlineProperties

Namespace:  DocumentFormat.OpenXml.Spreadsheet
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
Public Class OutlineProperties _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As OutlineProperties
public class OutlineProperties : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

18.3.1.61 outlinePr (Outline Properties)

Outline properties of the worksheet.

[Example:This example indicates that when an outline is applied to data, formatting must be applied to the outline result.

<sheetPr>
<outlinePr applyStyles="1"/>
</sheetPr>

end example]

Parent Elements

sheetPr (§18.3.1.82)

Attributes

Description

applyStyles (Apply Styles in Outline)

Flag indicating whether to apply styles in an outline, when outline is applied. Outline styles are described in Styles (§18.8).

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

showOutlineSymbols (Show Outline Symbols)

Flag indicating whether the sheet has outline symbols visible. This flag shall always be overridden by the showOutlineSymbols attribute on sheetView when there is a conflict.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

summaryBelow (Summary Below)

Flag indicating whether summary rows appear below detail in an outline, when applying an outline.

When true a summary row is inserted below the detailed data being summarized and a new outline level is established on that row.

When false a summary row is inserted above the detailed data being summarized and a new outline level is established on that row.

Note that toggling this flag on existing outlines requires an update to cell table, specifically, putting the summary functions in the proper rows, and flagging these rows as new outline levels, and possibly resetting their collapsed state.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

summaryRight (Summary Right)

Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.

When true a summary column is inserted to the right of the detailed data being summarized and a new outline level is established on that column.

When false a summary column is inserted to the left of the detailed data being summarized and a new outline level is established on that column.

Note that toggling this flag on existing outlines requires an update to cell table, specifically, putting the summary functions in the proper columns, and flagging these columns as new outline levels, and possibly resetting their collapsed state.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

[Note: The W3C XML Schema definition of this element’s content model (CT_OutlinePr) is located in §A.2. end note]

© ISO/IEC29500: 2008.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

OutlineProperties Members

DocumentFormat.OpenXml.Spreadsheet Namespace