Frame Class

Create a new Frame.

All the Frames that are currently referenced, indexed by ID. This property is only set if TrackAll(true) has previously been called.

The zip URI to the original document on which this frame was based.

The children of this frame.

For example a ParagraphFrame may a number of LineFrames as children.

Whether to highlight and annotate this frame for debugging purposes. The bounds, margins, padding and clip rectangle will be shown if they are available.

The line number within the original document on which this frame was based. If there is no obvious relationship with a particular line then the value will be -1. In this case you may wish to look at the line associated with the parent object. If you want to take advantage of the this property you will typically first want to set Options.FormatXml to true.

Get the margins for the frame. The margins extend out from the bounds of the frame and are kept clear of other content.

The original Frame on which this is based.

A Frame may spawn siblings. For example if a ParagraphFrame spans two pages it will need to be split into two. However the OriginalSelf for both ParagraphFrames will be the first - original - one.

Get the padding for the frame. The padding extends in from the bounds of the frame and is kept clear of content within the frame.

The parent of this Frame.

For example the parent of a TextRunFrame is typically a LineFrame. The parent of that is a ParagraphFrame.

The number of times which this Frame has been asked to reflow.

The CascadingStyleStore for this Frame.

A human readable summary of this frame and the properties associated with it.

Adopt a Frame updating references as appropriate. This function should be called after adding a Frame to the Children of another Frame.

Gets from within the Word package, the original document on which a frame was based.

Perform an action on this frame and all frames underneath it in the tree.

Enable or disable tracking of Frames. When tracking is enabled Frames are available via the All property. When this function is called the next ID is reset to zero.

The bounds of this Frame.

The ID for this Frame. IDs are allocated incrementally.