API Reference
RtfParagraphFrame
Absolute positioning and frame metadata for an RTF paragraph.
Inheritance
- Object
- RtfParagraphFrame
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property RtfParagraph.Frame
- Method RtfParagraphFrame.SetAnchors
- Method RtfParagraphFrame.SetDropCap
- Method RtfParagraphFrame.SetPosition
- Method RtfParagraphFrame.SetSize
- Method RtfParagraphFrame.SetWrapping
- Property RtfStyle.Frame
Accepted by parameters
- Method RtfParagraph.SetFrame
- Method RtfStyle.SetFrame
Constructors
public RtfParagraphFrame() #Methods
public RtfParagraphFrame SetAnchors(Nullable<RtfParagraphFrameHorizontalAnchor> horizontalAnchor = null, Nullable<RtfParagraphFrameVerticalAnchor> verticalAnchor = null) #RtfParagraphFrameSets frame reference anchors.
Parameters
- horizontalAnchor System.Nullable{OfficeIMO.Rtf.RtfParagraphFrameHorizontalAnchor} = null
- verticalAnchor System.Nullable{OfficeIMO.Rtf.RtfParagraphFrameVerticalAnchor} = null
public RtfParagraphFrame SetDropCap(Nullable<Int32> lines, Nullable<RtfDropCapKind> kind) #RtfParagraphFrameSets drop-cap metadata for this paragraph frame.
Parameters
- lines System.Nullable{System.Int32}
- kind System.Nullable{OfficeIMO.Rtf.RtfDropCapKind}
public RtfParagraphFrame SetPosition(Nullable<RtfParagraphFrameHorizontalPosition> horizontalPosition = null, Nullable<Int32> horizontalTwips = null, Nullable<RtfParagraphFrameVerticalPosition> verticalPosition = null, Nullable<Int32> verticalTwips = null) #RtfParagraphFrameSets horizontal and vertical frame positioning.
Parameters
- horizontalPosition System.Nullable{OfficeIMO.Rtf.RtfParagraphFrameHorizontalPosition} = null
- horizontalTwips System.Nullable{System.Int32} = null
- verticalPosition System.Nullable{OfficeIMO.Rtf.RtfParagraphFrameVerticalPosition} = null
- verticalTwips System.Nullable{System.Int32} = null
public RtfParagraphFrame SetSize(Nullable<Int32> widthTwips = null, Nullable<Int32> heightTwips = null) #RtfParagraphFrameSets frame dimensions in twips.
Parameters
- widthTwips System.Nullable{System.Int32} = null
- heightTwips System.Nullable{System.Int32} = null
public RtfParagraphFrame SetWrapping(Nullable<Boolean> noWrap = null, Nullable<Int32> allDirectionsTwips = null, Nullable<Int32> horizontalTwips = null, Nullable<Int32> verticalTwips = null, Nullable<Boolean> overlayText = null, Nullable<Boolean> noOverlap = null) #RtfParagraphFrameSets frame wrapping and overlay behavior.
Parameters
- noWrap System.Nullable{System.Boolean} = null
- allDirectionsTwips System.Nullable{System.Int32} = null
- horizontalTwips System.Nullable{System.Int32} = null
- verticalTwips System.Nullable{System.Int32} = null
- overlayText System.Nullable{System.Boolean} = null
- noOverlap System.Nullable{System.Boolean} = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public Nullable<Int32> WidthTwips { get; set; } #Frame width in twips, represented by \absw.
public Nullable<Int32> HeightTwips { get; set; } #Frame height in twips, represented by \absh. Negative values request exact height.
public Nullable<RtfParagraphFrameHorizontalAnchor> HorizontalAnchor { get; set; } #Horizontal reference frame.
public Nullable<RtfParagraphFrameVerticalAnchor> VerticalAnchor { get; set; } #Vertical reference frame.
public Nullable<RtfParagraphFrameHorizontalPosition> HorizontalPosition { get; set; } #Horizontal positioning mode.
public Nullable<Int32> HorizontalPositionTwips { get; set; } #Absolute horizontal offset in twips used by \posx or \posnegx.
public Nullable<RtfParagraphFrameVerticalPosition> VerticalPosition { get; set; } #Vertical positioning mode.
public Nullable<Int32> VerticalPositionTwips { get; set; } #Absolute vertical offset in twips used by \posy or \posnegy.
public Boolean AnchorLocked { get; set; } #Whether the frame anchor is locked to its paragraph, represented by \abslock.
public Nullable<Boolean> NoOverlap { get; set; } #Whether the frame avoids overlap, represented by \absnoovrlp.
public Boolean NoWrap { get; set; } #Whether main text should not wrap around the frame, represented by \nowrap.
public Nullable<Int32> TextWrapDistanceTwips { get; set; } #Distance in twips from surrounding text in all directions, represented by \dxfrtext.
public Nullable<Int32> TextWrapDistanceHorizontalTwips { get; set; } #Horizontal distance in twips from surrounding text, represented by \dfrmtxtx.
public Nullable<Int32> TextWrapDistanceVerticalTwips { get; set; } #Vertical distance in twips from surrounding text, represented by \dfrmtxty.
public Boolean OverlayText { get; set; } #Whether main text flows underneath the frame, represented by \overlay.
public Nullable<Int32> DropCapLines { get; set; } #Number of lines occupied by a drop cap, represented by \dropcapli.
public Nullable<RtfDropCapKind> DropCapKind { get; set; } #Drop-cap placement, represented by \dropcapt.
public Boolean HasAnyValue { get; } #Whether any frame metadata has been set.