StylePaneFormatFilter Class
Suggested Filtering for List of Document Styles.When the object is serialized out as xml, its qualified name is w:stylePaneFormatFilter.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Wordprocessing.StylePaneFormatFilter
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class StylePaneFormatFilter _
Inherits OpenXmlLeafElement
'Usage
Dim instance As StylePaneFormatFilter
public class StylePaneFormatFilter : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
17.15.1.85 stylePaneFormatFilter (Suggested Filtering for List of Document Styles)
This element specifies a set of suggested filters which should be applied to the list of document styles in this application if the styles are displayed in a user interface.
If this element is omitted, then all settings defined by this element are turned off.
[Example: Consider a document with the following value in its document settings:
<w:stylePaneFormatFilter w:customStyles="true" w:top3HeadingStyles="true" />
The stylePaneFormatFilter element's settings specify two suggested filter options for the list of document styles:
Only custom styles should be shown
Heading styles with a styleId of Heading1 to Heading3 should always be displayed in the list
end example]
Parent Elements |
|---|
settings (§17.15.1.78) |
Attributes |
Description |
|---|---|
allStyles (Display All Styles) |
Specifies that all styles present in the Styles part should be displayed in the list of document styles. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
alternateStyleNames (Use the Alternate Style Name) |
Specifies that primary names for styles should not be shown if an alternate name using the name element (§17.7.4.9) exists. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
clearFormatting (Display Styles to Remove Formatting) |
Specifies that a style should be present which removes all formatting and styles from text. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
customStyles (Display Only Custom Styles) |
Specifies that only styles with the customStyle attribute should be displayed in the list of document styles. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
directFormattingOnNumbering (Display Direct Formatting on Numbering Data) |
Specifies that all unique forms of direct formatting of numbering data should be displayed in the list of document styles as though they were each a unique style. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
directFormattingOnParagraphs (Display Paragraph Level Direct Formatting) |
Specifies that all unique forms of paragraph-level direct formatting should be displayed in the list of document styles as though they were each a unique style. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
directFormattingOnRuns (Display Run Level Direct Formatting) |
Specifies that all unique forms of run-level direct formatting should be displayed in the list of document styles as though they were each a unique style. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
directFormattingOnTables (Display Direct Formatting on Tables) |
Specifies that all unique forms of direct formatting of tables should be displayed in the list of document styles as though they were each a unique style. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
headingStyles (Display Heading Styles) |
Specifies that heading styles (styles with a styleId of Heading1 to Heading9) should be displayed in the list of document styles when the previous style is used in the document and/or is present in the Styles part. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
latentStyles (Display Latent Styles) |
Specifies that all latent styles should be displayed in the list of document styles. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
numberingStyles (Display Numbering Styles) |
Specifies that numbering styles should be displayed in the list of document styles. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
stylesInUse (Display Styles in Use) |
Specifies that only styles used in the document should be displayed in the list of document styles. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
tableStyles (Display Table Styles) |
Specifies that table styles should be displayed in the list of document styles. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
top3HeadingStyles (Display Heading 1 through 3) |
Specifies that heading styles with a styleId of Heading1 to Heading3 should always be displayed in the list of document styles. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
visibleStyles (Only Show Visible Styles) |
Specifies that styles should only be shown if the semiHidden element (§17.7.4.16) is false and the hidden element (§17.7.4.4) is false. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
[Note: The W3C XML Schema definition of this element’s content model (CT_StylePaneFilter) is located in §A.1. 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.