# RtfPageBorder

Formatting for one side of an RTF page border.

Class 

`OfficeIMO.Rtf`

**Namespace**

`OfficeIMO.Rtf`

**Assembly**

`OfficeIMO.Rtf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[RtfPageBorder.cs:27](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfPageBorder.cs#L27)

**Implements**

`IRtfCloneable`

**Modifiers**

sealed

Formatting for one side of an RTF page border.

## Inheritance

- object
- RtfPageBorder

## Usage

Explore 6 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 6

- Method [RtfPageBorder.Set](/api/rtf/officeimo-rtf-rtfpageborder/#method-set-officeimo-rtf-rtfpageborderstyle-nullable-system-int32-nullable-system-int32-nullable-system-int32)
- Method [RtfPageBorders.GetBorder](/api/rtf/officeimo-rtf-rtfpageborders/#method-getborder-officeimo-rtf-rtfpageborderside)
- Property [RtfPageBorders.Bottom](/api/rtf/officeimo-rtf-rtfpageborders/#property-bottom)
- Property [RtfPageBorders.Left](/api/rtf/officeimo-rtf-rtfpageborders/#property-left)
- Property [RtfPageBorders.Right](/api/rtf/officeimo-rtf-rtfpageborders/#property-right)
- Property [RtfPageBorders.Top](/api/rtf/officeimo-rtf-rtfpageborders/#property-top)

Filter members 

Show inherited

## Constructors

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

## Methods

`public RtfPageBorder Set(RtfPageBorderStyle style, int? width = null, int? space = null, int? colorIndex = null)` [#](#method-set-officeimo-rtf-rtfpageborderstyle-nullable-system-int32-nullable-system-int32-nullable-system-int32)

[RtfPageBorder.cs:27](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfPageBorder.cs#L27)

Sets the page border line properties.

Parameters

**style OfficeIMO.Rtf.RtfPageBorderStyle required**

**width int? = null optional**

**space int? = null optional**

**colorIndex int? = null optional**

Returns

`RtfPageBorder`

## 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 RtfPageBorderStyle Style { get; set; }` [#](#property-style)

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

Border line style.

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

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

Border width value carried by the RTF \brdrw control.

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

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

Space between the page border and the measured edge, represented by \brsp.

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

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

One-based color table index.

`public bool Shadow { get; set; }` [#](#property-shadow)

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

Whether the border has a shadow effect.

`public bool Frame { get; set; }` [#](#property-frame)

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

Whether the border is displayed as a frame border.

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

[RtfPageBorder.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfPageBorder.cs#L39)

Whether any border formatting is present.

<!-- PowerForge markdown artifact sha256:D8D3EFD6B98B6B3DCB20B24B29E1A1E74C1B2D6B3888CEE56E7FEAF577017C72 -->
