# RtfParagraphFrame

Absolute positioning and frame metadata for an RTF paragraph.

Class 

`OfficeIMO.Rtf`

**Namespace**

`OfficeIMO.Rtf`

**Assembly**

`OfficeIMO.Rtf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[RtfParagraphFrame.cs:80](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L80)

**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.

### Returned or exposed by 7

- Property [RtfParagraph.Frame](/api/rtf/officeimo-rtf-rtfparagraph/#property-frame)
- Method [RtfParagraphFrame.SetAnchors](/api/rtf/officeimo-rtf-rtfparagraphframe/#method-setanchors-nullable-officeimo-rtf-rtfparagraphframehorizontalanchor-nullable-officeimo-rtf-rtfparagraphframeverticalanchor)
- Method [RtfParagraphFrame.SetDropCap](/api/rtf/officeimo-rtf-rtfparagraphframe/#method-setdropcap-nullable-system-int32-nullable-officeimo-rtf-rtfdropcapkind)
- Method [RtfParagraphFrame.SetPosition](/api/rtf/officeimo-rtf-rtfparagraphframe/#method-setposition-nullable-officeimo-rtf-rtfparagraphframehorizontalposition-nullable-system-int32-nullable-officeimo-rtf-rtfparagraphframeverticalposition-nullable-system-int32)
- Method [RtfParagraphFrame.SetSize](/api/rtf/officeimo-rtf-rtfparagraphframe/#method-setsize-nullable-system-int32-nullable-system-int32)
- Method [RtfParagraphFrame.SetWrapping](/api/rtf/officeimo-rtf-rtfparagraphframe/#method-setwrapping-nullable-system-boolean-nullable-system-int32-nullable-system-int32-nullable-system-int32-nullable-system-boolean-nullable-system-boolean)
- Property [RtfStyle.Frame](/api/rtf/officeimo-rtf-rtfstyle/#property-frame)

### Accepted by parameters 2

- Method [RtfParagraph.SetFrame](/api/rtf/officeimo-rtf-rtfparagraph/#method-setframe-action-officeimo-rtf-rtfparagraphframe) parameter `configure`
- Method [RtfStyle.SetFrame](/api/rtf/officeimo-rtf-rtfstyle/#method-setframe-action-officeimo-rtf-rtfparagraphframe) parameter `configure`

Filter members 

Show inherited

## Constructors

`public RtfParagraphFrame()` [#](#constructor-ctor)

## Methods

`public RtfParagraphFrame SetAnchors(RtfParagraphFrameHorizontalAnchor? horizontalAnchor = null, RtfParagraphFrameVerticalAnchor? verticalAnchor = null)` [#](#method-setanchors-nullable-officeimo-rtf-rtfparagraphframehorizontalanchor-nullable-officeimo-rtf-rtfparagraphframeverticalanchor)

[RtfParagraphFrame.cs:87](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L87)

Sets frame reference anchors.

Parameters

**horizontalAnchor OfficeIMO.Rtf.RtfParagraphFrameHorizontalAnchor? = null optional**

**verticalAnchor OfficeIMO.Rtf.RtfParagraphFrameVerticalAnchor? = null optional**

Returns

`RtfParagraphFrame`

`public RtfParagraphFrame SetDropCap(int? lines, RtfDropCapKind? kind)` [#](#method-setdropcap-nullable-system-int32-nullable-officeimo-rtf-rtfdropcapkind)

[RtfParagraphFrame.cs:130](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L130)

Sets drop-cap metadata for this paragraph frame.

Parameters

**lines int? required**

**kind OfficeIMO.Rtf.RtfDropCapKind? required**

Returns

`RtfParagraphFrame`

`public RtfParagraphFrame SetPosition(RtfParagraphFrameHorizontalPosition? horizontalPosition = null, int? horizontalTwips = null, RtfParagraphFrameVerticalPosition? verticalPosition = null, int? verticalTwips = null)` [#](#method-setposition-nullable-officeimo-rtf-rtfparagraphframehorizontalposition-nullable-system-int32-nullable-officeimo-rtf-rtfparagraphframeverticalposition-nullable-system-int32)

[RtfParagraphFrame.cs:98](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L98)

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**

Returns

`RtfParagraphFrame`

`public RtfParagraphFrame SetSize(int? widthTwips = null, int? heightTwips = null)` [#](#method-setsize-nullable-system-int32-nullable-system-int32)

[RtfParagraphFrame.cs:80](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L80)

Sets frame dimensions in twips.

Parameters

**widthTwips int? = null optional**

**heightTwips int? = null optional**

Returns

`RtfParagraphFrame`

`public RtfParagraphFrame SetWrapping(bool? noWrap = null, int? allDirectionsTwips = null, int? horizontalTwips = null, int? verticalTwips = null, bool? overlayText = null, bool? noOverlap = null)` [#](#method-setwrapping-nullable-system-boolean-nullable-system-int32-nullable-system-int32-nullable-system-int32-nullable-system-boolean-nullable-system-boolean)

[RtfParagraphFrame.cs:113](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L113)

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**

Returns

`RtfParagraphFrame`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public int? WidthTwips { get; set; }` [#](#property-widthtwips)

[RtfParagraphFrame.cs:8](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L8)

Frame width in twips, represented by \absw.

`public int? HeightTwips { get; set; }` [#](#property-heighttwips)

[RtfParagraphFrame.cs:11](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L11)

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

`public RtfParagraphFrameHorizontalAnchor? HorizontalAnchor { get; set; }` [#](#property-horizontalanchor)

[RtfParagraphFrame.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L14)

Horizontal reference frame.

`public RtfParagraphFrameVerticalAnchor? VerticalAnchor { get; set; }` [#](#property-verticalanchor)

[RtfParagraphFrame.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L17)

Vertical reference frame.

`public RtfParagraphFrameHorizontalPosition? HorizontalPosition { get; set; }` [#](#property-horizontalposition)

[RtfParagraphFrame.cs:20](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L20)

Horizontal positioning mode.

`public int? HorizontalPositionTwips { get; set; }` [#](#property-horizontalpositiontwips)

[RtfParagraphFrame.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L23)

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

`public RtfParagraphFrameVerticalPosition? VerticalPosition { get; set; }` [#](#property-verticalposition)

[RtfParagraphFrame.cs:26](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L26)

Vertical positioning mode.

`public int? VerticalPositionTwips { get; set; }` [#](#property-verticalpositiontwips)

[RtfParagraphFrame.cs:29](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L29)

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

`public bool AnchorLocked { get; set; }` [#](#property-anchorlocked)

[RtfParagraphFrame.cs:32](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L32)

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

`public bool? NoOverlap { get; set; }` [#](#property-nooverlap)

[RtfParagraphFrame.cs:35](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L35)

Whether the frame avoids overlap, represented by \absnoovrlp.

`public bool NoWrap { get; set; }` [#](#property-nowrap)

[RtfParagraphFrame.cs:38](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L38)

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

`public int? TextWrapDistanceTwips { get; set; }` [#](#property-textwrapdistancetwips)

[RtfParagraphFrame.cs:41](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L41)

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

`public int? TextWrapDistanceHorizontalTwips { get; set; }` [#](#property-textwrapdistancehorizontaltwips)

[RtfParagraphFrame.cs:44](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L44)

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

`public int? TextWrapDistanceVerticalTwips { get; set; }` [#](#property-textwrapdistanceverticaltwips)

[RtfParagraphFrame.cs:47](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L47)

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

`public bool OverlayText { get; set; }` [#](#property-overlaytext)

[RtfParagraphFrame.cs:50](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L50)

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

`public int? DropCapLines { get; set; }` [#](#property-dropcaplines)

[RtfParagraphFrame.cs:53](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L53)

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

`public RtfDropCapKind? DropCapKind { get; set; }` [#](#property-dropcapkind)

[RtfParagraphFrame.cs:56](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L56)

Drop-cap placement, represented by \dropcapt.

`public bool HasAnyValue { get; }` [#](#property-hasanyvalue)

[RtfParagraphFrame.cs:60](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfParagraphFrame.cs#L60)

Whether any frame metadata has been set.

<!-- PowerForge markdown artifact sha256:7D6741058CC5069807E4A99145ADDD7702CC712687400A2D9D53933A1BC65EFF -->
