SummaryLength Class
Percentage of Document to Use When Generating Summary.When the object is serialized out as xml, its qualified name is w:summaryLength.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Wordprocessing.SummaryLength
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class SummaryLength _
Inherits OpenXmlLeafElement
'Usage
Dim instance As SummaryLength
public class SummaryLength : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
17.15.1.87 summaryLength (Percentage of Document to Use When Generating Summary)
This element specifies the size for automatic document summaries performed on the content of a WordprocessingML document. An automatic document summary is a subset of text contained in a document deemed by the hosting application to summarize the content of the WordprocessingML document. The val attribute of this element specifies the size of an automatic document summary to be performed on a given WordprocessingML document as a percentage of the total size of the given WordprocessingML document. Performing an automatic document summary is a runtime operation outside the scope of ISO/IEC 29500.
If this element is omitted, then applications can summarize this document to any desired size.
[Example: Consider a WordprocessingML document whose automatic document summary is to be ten percent of the size of the given WordprocessingML document. This requirement would be specified using the following WordprocessingML in the document settings part:
<w:summaryLength w:val="10%" />
The summaryLength element's val attribute is equal to 10% specifying that any automatic document summary is to be ten percent of the size of the document. end example]
Parent Elements |
|---|
settings (§17.15.1.78) |
Attributes |
Description |
|---|---|
val (Value in Percent) |
Specifies a measurement in whole percentage points, with a trailing percent sign (U+0025). [Example: Consider the following WordprocessingML fragment: <… w:val="50.125%" /> This value specifies a value of fifty and one-eighth percent. end example] The possible values for this attribute are defined by the ST_DecimalNumberOrPercent simple type (§17.18.11). |
[Note: The W3C XML Schema definition of this element’s content model (CT_DecimalNumberOrPrecent) 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.