Class Section
Container for block-level content with page layout settings including size, orientation, margins, headers, and footers, defining how content flows across pages.
Inherited Members
Namespace: Telerik.Windows.Documents.Flow.Model
Assembly: Telerik.Windows.Documents.Flow.dll
Syntax
public sealed class Section : BlockContainerBase, IChildrenList, IElementWithProperties, ISdtBlock
Remarks
In addition to the collection of blocks, section can contain one or more instances of Header and Footer through the Headers and Footers properties.
Constructors
Section(RadFlowDocument)
Initializes a new Section with default page layout settings and empty block, header, and footer collections in the specified document.
Declaration
public Section(RadFlowDocument document)
Parameters
|
RadFlowDocument
document
The document in which the element will be added. |
Fields
ChapterHeadingStyleIndexPropertyDefinition
Style property definition for the heading level (1-9) used to extract chapter numbers for page numbering.
Declaration
public static readonly StylePropertyDefinition<int? > ChapterHeadingStyleIndexPropertyDefinition
Field Value
|
StylePropertyDefinition<System.Nullable<System.Int32>>
|
ChapterSeparatorCharacterPropertyDefinition
Style property definition for the character separating chapter numbers from page numbers in page numbering fields.
Declaration
public static readonly StylePropertyDefinition<ChapterSeparatorType? > ChapterSeparatorCharacterPropertyDefinition
Field Value
|
StylePropertyDefinition<System.Nullable<ChapterSeparatorType>>
|
FooterBottomMarginPropertyDefinition
HasDifferentFirstPageHeaderFooterPropertyDefinition
HeaderTopMarginPropertyDefinition
Style property definition for the distance from the top page edge to the start of header content in device independent pixels (1/96 inch).
Declaration
public static readonly StylePropertyDefinition<double? > HeaderTopMarginPropertyDefinition
Field Value
|
StylePropertyDefinition<System.Nullable<System.Double>>
|
PageMarginsPropertyDefinition
Style property definition for page margins, defining the distance between page edges and the content area.
Declaration
public static readonly StylePropertyDefinition<Padding> PageMarginsPropertyDefinition
Field Value
|
StylePropertyDefinition<Padding>
|
PageNumberFormatPropertyDefinition
Style property definition for the numbering format applied to page numbers (decimal, Roman numerals, letters, etc.).
Declaration
public static readonly StylePropertyDefinition<NumberingStyle? > PageNumberFormatPropertyDefinition
Field Value
|
StylePropertyDefinition<System.Nullable<NumberingStyle>>
|
PageOrientationPropertyDefinition
Style property definition for page orientation, controlling portrait or landscape layout.
Declaration
public static readonly StylePropertyDefinition<PageOrientation? > PageOrientationPropertyDefinition
Field Value
|
StylePropertyDefinition<System.Nullable<PageOrientation>>
|
PageSizePropertyDefinition
Style property definition for physical page dimensions in device independent pixels (1/96 inch).
Declaration
public static readonly StylePropertyDefinition<Size? > PageSizePropertyDefinition
Field Value
|
StylePropertyDefinition<System.Nullable<System.Windows.Size>>
|
SectionTypePropertyDefinition
Style property definition for section break type, controlling how the section begins relative to the previous section.
Declaration
public static readonly StylePropertyDefinition<SectionType? > SectionTypePropertyDefinition
Field Value
|
StylePropertyDefinition<System.Nullable<SectionType>>
|
StartingPageNumberPropertyDefinition
Style property definition for the initial page number assigned to the first page of this section.
Declaration
public static readonly StylePropertyDefinition<int? > StartingPageNumberPropertyDefinition
Field Value
|
StylePropertyDefinition<System.Nullable<System.Int32>>
|
VerticalAlignmentPropertyDefinition
Style property definition for vertical alignment of content within the page height.
Declaration
public static readonly StylePropertyDefinition<VerticalAlignment> VerticalAlignmentPropertyDefinition
Field Value
|
StylePropertyDefinition<VerticalAlignment>
|
Properties
FooterBottomMargin
Footers
HasDifferentFirstPageHeaderFooter
Headers
Header instances for this section, providing default, first-page, and even-page headers that appear at the top of pages.
Declaration
public Headers Headers { get; }
Property Value
|
Headers
The headers. |
HeaderTopMargin
Distance from the top edge of the page to the start of header content in device independent pixels (1/96 inch).
Declaration
public double HeaderTopMargin { get; set; }
Property Value
|
System.Double
The header top margin. |
PageMargins
Margins defining the distance between page edges and the content area, specified in device independent pixels (1/96 inch).
Declaration
public Padding PageMargins { get; set; }
Property Value
|
Padding
The page margins. |
PageNumberingSettings
Page numbering configuration for this section, controlling the starting number, format, and chapter heading association.
Declaration
public PageNumberingSettings PageNumberingSettings { get; }
Property Value
|
PageNumberingSettings
The page numbering settings. |
PageOrientation
Page orientation for this section, controlling whether pages are portrait or landscape; use Rotate() to change orientation with automatic margin adjustment.
Declaration
public PageOrientation PageOrientation { get; set; }
Property Value
|
PageOrientation
The page orientation. |
PageSize
Physical page dimensions in device independent pixels (1/96 inch); use ToSize(PaperTypes) for standard paper sizes like A4 or Letter.
Declaration
public Size PageSize { get; set; }
Property Value
|
System.Windows.Size
The size of the page. |
Remarks
For setting common page sizes ToSize(PaperTypes) method can be used.
Properties
Page layout and section properties, providing access to page size, orientation, margins, headers/footers margins, and section type settings.
Declaration
public SectionProperties Properties { get; }
Property Value
|
SectionProperties
The properties. |
SectionType
Section break type controlling how this section begins relative to the previous section (continuous, new page, even page, or odd page).
Declaration
public SectionType SectionType { get; set; }
Property Value
|
SectionType
The type of the section. |
VerticalAlignment
Vertical alignment of content within the page, controlling whether content is aligned to the top, center, bottom, or justified across the page height.
Declaration
public VerticalAlignment VerticalAlignment { get; set; }
Property Value
|
VerticalAlignment
The vertical alignment. |
Methods
Clone()
Creates a deep copy of this section including all blocks, headers, footers, and layout properties, associated to the same document.
Declaration
public Section Clone()
Returns
|
Section
The cloned element. |
Clone(RadFlowDocument)
Creates a deep copy of this section including all blocks, headers, footers, and layout properties, associated to the specified document for cross-document copying.
Declaration
public Section Clone(RadFlowDocument document)
Parameters
|
RadFlowDocument
document
The document to which the cloned element should be associated. |
Returns
|
Section
The cloned element. |
Rotate(PageOrientation)
Changes the page orientation to the specified value and automatically adjusts page size and margins to maintain consistent layout.
Declaration
public void Rotate(PageOrientation orientation)
Parameters
|
PageOrientation
orientation
The page orientation. |
Explicit Interface Implementations
IElementWithProperties.Properties
Gets the properties.
Declaration
DocumentElementPropertiesBase IElementWithProperties.Properties { get; }
Returns
|
DocumentElementPropertiesBase
The properties. |