# RtfPageBorderScope

Page range to which page borders apply.

Enum 

`OfficeIMO.Rtf`

**Namespace**

`OfficeIMO.Rtf`

**Assembly**

`OfficeIMO.Rtf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[RtfPageBorderScope.cs:6](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfPageBorderScope.cs#L6)

**Base**

`Enum`

**Implements**

`IComparable` `ISpanFormattable` `IFormattable` `IConvertible`

**Modifiers**

sealed

Page range to which page borders apply.

## Inheritance

- Enum
- RtfPageBorderScope

## Usage

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

- Property [RtfPageBorders.Scope](/api/rtf/officeimo-rtf-rtfpageborders/#property-scope)
- Field [RtfPageBorderScope.AllExceptFirstPageInSection](/api/rtf/officeimo-rtf-rtfpageborderscope/#field-allexceptfirstpageinsection)
- Field [RtfPageBorderScope.AllPagesInSection](/api/rtf/officeimo-rtf-rtfpageborderscope/#field-allpagesinsection)
- Field [RtfPageBorderScope.FirstPageInSection](/api/rtf/officeimo-rtf-rtfpageborderscope/#field-firstpageinsection)
- Field [RtfPageBorderScope.WholeDocument](/api/rtf/officeimo-rtf-rtfpageborderscope/#field-wholedocument)

### Accepted by parameters 2

- Method [RtfLosslessEditor.SetPageBorderOptions](/api/rtf/officeimo-rtf-rtflosslesseditor/#method-setpageborderoptions-nullable-system-boolean-nullable-system-boolean-nullable-system-boolean-nullable-officeimo-rtf-rtfpageborderscope-nullable-system-boolean-nullable-officeimo-rtf-rtfpageborderoffset) parameter `scope`
- Method [RtfPageBorders.SetDisplayOptions](/api/rtf/officeimo-rtf-rtfpageborders/#method-setdisplayoptions-nullable-officeimo-rtf-rtfpageborderscope-nullable-system-boolean-nullable-officeimo-rtf-rtfpageborderoffset) parameter `scope`

Filter members 

Show inherited

## Inherited Methods

`public int CompareTo(object? target)` [#](#method-compareto-object)

Inherited from Enum

Parameters

**target object? required**

Returns

`int`

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

Inherited from Enum

Parameters

**obj object? required**

Returns

`bool`

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

Inherited from Enum

Returns

`int`

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

Inherited from object

Returns

`Type`

`public TypeCode GetTypeCode()` [#](#method-gettypecode)

Inherited from Enum

Returns

`TypeCode`

`public bool HasFlag(Enum flag)` [#](#method-hasflag-enum)

Inherited from Enum

Parameters

**flag Enum required**

Returns

`bool`

ToString 4 overloads

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

Inherited from Enum

Returns

`string`

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

Inherited from Enum

Parameters

**format string? required**

Returns

`string`

`public string ToString(IFormatProvider? provider)` [#](#method-tostring-iformatprovider)

Inherited from Enum

`Obsolete("The provider argument is not used. Use ToString() instead.")`

Parameters

**provider IFormatProvider? required**

Returns

`string`

`public string ToString(string? format, IFormatProvider? provider)` [#](#method-tostring-string-iformatprovider)

Inherited from Enum

`Obsolete("The provider argument is not used. Use ToString(String) instead.")`

Parameters

**format string? required**

**provider IFormatProvider? required**

Returns

`string`

## Values

`public const RtfPageBorderScope AllPagesInSection` [#](#field-allpagesinsection)

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

Apply to all pages in the section.

Value: `0`

`public const RtfPageBorderScope FirstPageInSection` [#](#field-firstpageinsection)

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

Apply only to the first page in the section.

Value: `1`

`public const RtfPageBorderScope AllExceptFirstPageInSection` [#](#field-allexceptfirstpageinsection)

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

Apply to all pages except the first page in the section.

Value: `2`

`public const RtfPageBorderScope WholeDocument` [#](#field-wholedocument)

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

Apply to the whole document.

Value: `3`

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