Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

RtfParagraphFrame

OfficeIMO.Rtf

Namespace
OfficeIMO.Rtf
Assembly
OfficeIMO.Rtf
Source revision
ba882f6b0d07 with working tree changes
Implements
IRtfCloneable
Modifiers
sealed

Absolute positioning and frame metadata for an RTF paragraph.

Inheritance

  • object
  • RtfParagraphFrame

Usage

Explore 9 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 2

Constructors

public RtfParagraphFrame() #

Methods

public RtfParagraphFrame SetAnchors(RtfParagraphFrameHorizontalAnchor? horizontalAnchor = null, RtfParagraphFrameVerticalAnchor? verticalAnchor = null) #

Sets frame reference anchors.

Parameters

horizontalAnchor OfficeIMO.Rtf.RtfParagraphFrameHorizontalAnchor? = null optional
verticalAnchor OfficeIMO.Rtf.RtfParagraphFrameVerticalAnchor? = null optional
public RtfParagraphFrame SetDropCap(int? lines, RtfDropCapKind? kind) #

Sets drop-cap metadata for this paragraph frame.

Parameters

lines int? required
kind OfficeIMO.Rtf.RtfDropCapKind? required
public RtfParagraphFrame SetPosition(RtfParagraphFrameHorizontalPosition? horizontalPosition = null, int? horizontalTwips = null, RtfParagraphFrameVerticalPosition? verticalPosition = null, int? verticalTwips = null) #

Sets horizontal and vertical frame positioning.

Parameters

horizontalPosition OfficeIMO.Rtf.RtfParagraphFrameHorizontalPosition? = null optional
horizontalTwips int? = null optional
verticalPosition OfficeIMO.Rtf.RtfParagraphFrameVerticalPosition? = null optional
verticalTwips int? = null optional
public RtfParagraphFrame SetSize(int? widthTwips = null, int? heightTwips = null) #

Sets frame dimensions in twips.

Parameters

widthTwips int? = null optional
heightTwips int? = null optional
public RtfParagraphFrame SetWrapping(bool? noWrap = null, int? allDirectionsTwips = null, int? horizontalTwips = null, int? verticalTwips = null, bool? overlayText = null, bool? noOverlap = null) #

Sets frame wrapping and overlay behavior.

Parameters

noWrap bool? = null optional
allDirectionsTwips int? = null optional
horizontalTwips int? = null optional
verticalTwips int? = null optional
overlayText bool? = null optional
noOverlap bool? = null optional

Properties

public int? WidthTwips { get; set; } #

Frame width in twips, represented by \absw.

public int? HeightTwips { get; set; } #

Frame height in twips, represented by \absh. Negative values request exact height.

public RtfParagraphFrameHorizontalAnchor? HorizontalAnchor { get; set; } #

Horizontal reference frame.

public RtfParagraphFrameVerticalAnchor? VerticalAnchor { get; set; } #

Vertical reference frame.

public RtfParagraphFrameHorizontalPosition? HorizontalPosition { get; set; } #

Horizontal positioning mode.

public int? HorizontalPositionTwips { get; set; } #

Absolute horizontal offset in twips used by \posx or \posnegx.

public RtfParagraphFrameVerticalPosition? VerticalPosition { get; set; } #

Vertical positioning mode.

public int? VerticalPositionTwips { get; set; } #

Absolute vertical offset in twips used by \posy or \posnegy.

public bool AnchorLocked { get; set; } #

Whether the frame anchor is locked to its paragraph, represented by \abslock.

public bool? NoOverlap { get; set; } #

Whether the frame avoids overlap, represented by \absnoovrlp.

public bool NoWrap { get; set; } #

Whether main text should not wrap around the frame, represented by \nowrap.

public int? TextWrapDistanceTwips { get; set; } #

Distance in twips from surrounding text in all directions, represented by \dxfrtext.

public int? TextWrapDistanceHorizontalTwips { get; set; } #

Horizontal distance in twips from surrounding text, represented by \dfrmtxtx.

public int? TextWrapDistanceVerticalTwips { get; set; } #

Vertical distance in twips from surrounding text, represented by \dfrmtxty.

public bool OverlayText { get; set; } #

Whether main text flows underneath the frame, represented by \overlay.

public int? DropCapLines { get; set; } #

Number of lines occupied by a drop cap, represented by \dropcapli.

public RtfDropCapKind? DropCapKind { get; set; } #

Drop-cap placement, represented by \dropcapt.

public bool HasAnyValue { get; } #

Whether any frame metadata has been set.