LatentStyleExceptionInfo Class
Latent Style Exception.When the object is serialized out as xml, its qualified name is w:lsdException.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Wordprocessing.LatentStyleExceptionInfo
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class LatentStyleExceptionInfo _
Inherits OpenXmlLeafElement
'Usage
Dim instance As LatentStyleExceptionInfo
public class LatentStyleExceptionInfo : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
17.7.2.8 lsdException (Latent Style Exception)
This element specifies the properties which shall be applied a single latent style for this document. Latent styles refer to any set of known style definitions which have not been included in the current document.
[Example: Consider a WordprocessingML document which contains text specified in one of two styles: Heading1 or Normal. Based on this, the document only needs to store the formatting properties for those two styles, saving the additional overhead which would be required to save all of the styles supported by the hosting application.
However, if the documentProtection element (§17.15.1.29) specifies that the hosting application must prevent the use of any style whose locked element (§17.7.4.7) is set to false, then the locking state of all styles known to that application become useful and necessary to maintain the current state of the document. Using latent styles, this information can be stored without storing any formatting properties for those styles.
For example, if all styles which are not stored in the document must be locked except for the style with a primary name (§17.7.4.9) of Heading 2. This requirement would be specified using latent styles as follows:
<w:latentStyles … w:defLockedState="true"> <w:lsdException w:name="Heading 2" w:locked="false"/> </w:latentStyles>
The lsdException element specifies that the latent style with a primary name of Heading 2 must have a locked state setting of false. end example]
Parent Elements |
|---|
latentStyles (§17.7.4.5) |
Attributes |
Description |
|---|---|
locked (Latent Style Locking Setting) |
Specifies the default setting for the locked element (§17.7.4.7) which shall be applied to the latent style with the matching style name value. If this element is omitted, the default locked state for this latent style shall be determined by the defLockedState attribute on the parent latentStyles element. [Example: Consider a WordprocessingML document in which all styles which are not stored in the document must be locked except for the TestStyle style. This requirement would be specified using latent styles as follows: <w:latentStyles … w:defLockedState="true"> <w:lsdException w:name="TestStyle" w:locked="false"/> </w:latentStyles> The locked attribute on the latent style exception specifies that the TestStyle style must have a locked element setting of false by default. end example] The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
name (Primary Style Name) |
Specifies the primary name for the style which shall inherit this set of latent style property exceptions. If the current application does not know of an internal primary style with the current name, then this set of latent style exceptions can be ignored. [Example: Consider a WordprocessingML document in which all styles which are not stored in the document must be locked except for the TestStyle style. This requirement would be specified using latent styles as follows: <w:latentStyles … w:defLockedState="true"> <w:lsdException w:name="TestStyle" w:locked="false"/> </w:latentStyles> The name attribute on the latent style exception specifies that the TestStyle style must have this set of latent style properties (if the application knows of a style with this name). end example] The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13). |
qFormat (Latent Style Primary Style Setting) |
Specifies the default setting for the qFormat element (§17.7.4.14) which shall be applied to the latent style with the matching style name value. If this element is omitted, the default qFormat state for this latent style shall be determined by the defQFormat attribute on the parent latentStyles element. [Example: Consider a WordprocessingML document in which all styles which are not stored in the document must not be primary styles except for the TestStyle style. This requirement would be specified using latent styles as follows: <w:latentStyles … w:defQFormat="false"> <w:lsdException w:name="TestStyle" w:qFormat="true"/> </w:latentStyles> The qFormat attribute on the latent style exception specifies that the TestStyle style must have a qFormat element setting of true by default. end example] The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
semiHidden (Semi hidden text override) |
Specifies the default setting for the semiHidden element (§17.7.4.16) which shall be applied to the latent style with the matching style name value. If this element is omitted, the default semiHidden state for this latent style shall be determined by the defSemiHidden attribute on the parent latentStyles element. [Example: Consider a WordprocessingML document in which all styles which are not stored in the document must not be semi-hidden except for the TestStyle style. This requirement would be specified using latent styles as follows: <w:latentStyles … w:defSemiHidden="false"> <w:lsdException w:name="TestStyle" w:semiHidden="true"/> </w:latentStyles> The semiHidden attribute on the latent style exception specifies that the TestStyle style must have a semiHidden element setting of true by default. end example] The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
uiPriority (Override default sorting order) |
Specifies the default setting for the uiPriority element (§17.7.4.19) which shall be applied to the latent style with the matching style name value. If this element is omitted, the default uiPriority state for this latent style shall be determined by the defUIPriority attribute on the parent latentStyles element. [Example: Consider a WordprocessingML document in which all styles which are not stored in the document must have a priority value of 10 except for the TestStyle style. This requirement would be specified using latent styles as follows: <w:latentStyles … w:defUIPriority="10"> <w:lsdException w:name="TestStyle" w:uiPriority="25"/> </w:latentStyles> The uiPriority attribute on the latent style exception specifies that the TestStyle style must have a uiPriority element setting of 25 by default. end example] The possible values for this attribute are defined by the ST_DecimalNumber simple type (§17.18.10). |
unhideWhenUsed (Unhide when used) |
Specifies the default setting for the unhideWhenUsed element (§17.7.4.20) which shall be applied to the latent style with the matching style name value. If this element is omitted, the default unhideWhenUsed state for this latent style shall be determined by the defUnhideWhenUsed attribute on the parent latentStyles element. [Example: Consider a WordprocessingML document in which all styles are to be hidden until used except for the TestStyle style. This requirement would be specified using latent styles as follows: <w:latentStyles … w:defUnhideWhenUsed="true"> <w:lsdException w:name="TestStyle" w:unhideWhenUsed="false"/> </w:latentStyles> The unhideWhenUsed attribute on the latent style exception specifies that the TestStyle style must have an unhideWhenUsed element setting of false by default. end example] 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_LsdException) 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.