ReadModeInkLockDown class

Office 2013 and later

Freeze Document Layout. When the object is serialized out as xml, its qualified name is w:readModeInkLockDown.

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.ReadModeInkLockDown

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

public class ReadModeInkLockDown : OpenXmlLeafElement

[ISO/IEC 29500-1 1st Edition]

readModeInkLockDown (Freeze Document Layout)

This element specifies the exact set of page and text sizing parameters which shall be used to display the contents of a WordprocessingML document. [Rationale: This setting is typically used for documents that have been annotated using ink. This setting freezes the document's presentation such that the ink annotations must exist at the same position of the WordprocessingML document irrespective of the monitor on which the WordprocessingML document is rendered. end rationale]

This element shall only affect the display of WordprocessingML documents as follows:

  • When the actualPage attribute is specified with a value of true, the given WordprocessingML document's pages shall be rendered as they would normally be displayed. The resulting pages can have their magnification setting changed as desired. All other attributes shall be ignored.

  • When the actualPage attribute is specified with a value of false, the given WordprocessingML document's pages shall be rendered as virtual pages when loaded by a conforming hosting application irrespective of the given WordprocessingML document's view (§17.15.1.92). Virtual pages are pages with no correlation with the printed layout of a given WordprocessingML document that have been scaled by a conforming hosting application to improve the readability of a given WordprocessingML document when it is displayed. Specifically, the w and h attributes specify the width and height of the virtual pages, and the fontSz attribute specifies the scaling to be applied to text within the given WordprocessingML document.

[Example: Consider a WordprocessingML document that must be displayed using virtual pageswhen its contents are displayed. This state is specified using the following WordprocessingML in the document settings:

<w:readModeInkLockDown w:w="692" w:h="986" w:fontSz="95" w:actualPg="0"/> 

The readModeInkLockDown element has w and h attribute values which specify the width and height of the virtual pages to be used to render the given WordprocessingML document. Finally, the fontSz attribute specifies the scaling to be applied to text within the given WordprocessingML document. end example]

Parent Elements

settings (§17.15.1.78)

Attributes

Description

actualPg (Use Actual Pages, Not Virtual Pages)

Specifies if applications shall render this WordprocessingML document with actual pages, not virtual pages. Actual pages are pages rendered as they is printed.

A value of true specifies that the given WordprocessingML document's pages is rendered as they are printed, and the w, h, and fontSz attributes shall be ignored. A value of false specifies that the given WordprocessingML document's pages shall be rendered as virtual pages using the other attributes on this element.

[Example: Consider a WordprocessingML document that must be displayed using virtual pages. This state is specified using the following WordprocessingML in the document settings:

<w:readModeInkLockDown w:w="692" w:h="986" w:fontSz="95" w:actualPg="0" /> 

The actualPage attribute is equal to 0 specifying that the given WordprocessingML document must be rendered by conforming hosting applications using virtual pages. end example]

The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7).

fontSz (Font Size Scaling)

Specifies the percentage that text in a given WordprocessingML document shall be scaled by before it is displayed on a virtual page, including a trailing percent sign (U+0025).

This attribute shall only be used if the actualPage attribute equals off, 0, or false.

[Example: Consider a WordprocessingML document that must be displayed using virtual pages. This state is specified using the following WordprocessingML in the document settings:

<w:readModeInkLockDown w:w="692" w:h="986" w:fontSz="95%" w:actualPg="0" /> 

The fontSz attribute is equal to 95% specifying that the text in the WordprocessingML document must be displayed at 95% of its normal size when it is displayed on a virtual page. end example]

The possible values for this attribute are defined by the ST_DecimalNumberOrPercent simple type (§17.18.11).

h (Virtual Page Height)

Specifies the height of the virtual pages which shall be used in this document. This value is specified in pixels.

This attribute shall only be used if the actualPage attribute equals off, 0, or false.

[Example: Consider a WordprocessingML document that must be displayed using virtual pages. This state is specified using the following WordprocessingML in the document settings:

<w:readModeInkLockDown w:w="692" w:h="986" w:fontSz="95" w:actualPg="0" /> 

The h attribute is equal to 986 specifying that virtual pages in this document must be 986 pixels high. end example]

The possible values for this attribute are defined by the ST_PixelsMeasure simple type (§17.18.67).

w (Virtual Page Width)

Specifies the width of the virtual pages which shall be used in this document. This value is specified in pixels.

This attribute shall only be used if the actualPage attribute equals off, 0, or false.

[Example: Consider a WordprocessingML document that must be displayed using virtual pages. This state is specified using the following WordprocessingML in the document settings:

<w:readModeInkLockDown w:w="692" w:h="986" w:fontSz="95" w:actualPg="0" /> 

The w attribute is equal to 692 specifying that virtual pages in this document must be 692 pixels wide. end example]

The possible values for this attribute are defined by the ST_PixelsMeasure simple type (§17.18.67).

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

© ISO/IEC29500: 2008.

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