Class Section

A flow content element used for grouping of BlockBase elements.

Inheritance
System.Object
DocumentElementBase
BlockContainerBase
Section
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
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 instance of the Section class.

Declaration
public Section(RadFlowDocument document)
Parameters
RadFlowDocument document

The document in which the element will be added.

Fields

ChapterHeadingStyleIndexPropertyDefinition

Gets the chapter heading style index property definition.

Declaration
public static readonly StylePropertyDefinition<int? > ChapterHeadingStyleIndexPropertyDefinition
Field Value
StylePropertyDefinition<System.Nullable<System.Int32>>

ChapterSeparatorCharacterPropertyDefinition

Gets the chapter separator character property definition.

Declaration
public static readonly StylePropertyDefinition<ChapterSeparatorType? > ChapterSeparatorCharacterPropertyDefinition
Field Value
StylePropertyDefinition<System.Nullable<ChapterSeparatorType>>

FooterBottomMarginPropertyDefinition

Gets the header top margin property definition.

Declaration
public static readonly StylePropertyDefinition<double? > FooterBottomMarginPropertyDefinition
Field Value
StylePropertyDefinition<System.Nullable<System.Double>>

HasDifferentFirstPageHeaderFooterPropertyDefinition

Gets the font size property definition.

Declaration
public static readonly StylePropertyDefinition<bool? > HasDifferentFirstPageHeaderFooterPropertyDefinition
Field Value
StylePropertyDefinition<System.Nullable<System.Boolean>>

HeaderTopMarginPropertyDefinition

Gets the header top margin property definition.

Declaration
public static readonly StylePropertyDefinition<double? > HeaderTopMarginPropertyDefinition
Field Value
StylePropertyDefinition<System.Nullable<System.Double>>

PageMarginsPropertyDefinition

Gets the page margins property definition.

Declaration
public static readonly StylePropertyDefinition<Padding> PageMarginsPropertyDefinition
Field Value
StylePropertyDefinition<Padding>

PageNumberFormatPropertyDefinition

Gets the page number format property definition.

Declaration
public static readonly StylePropertyDefinition<NumberingStyle? > PageNumberFormatPropertyDefinition
Field Value
StylePropertyDefinition<System.Nullable<NumberingStyle>>

PageOrientationPropertyDefinition

Gets the page orientation property definition.

Declaration
public static readonly StylePropertyDefinition<PageOrientation? > PageOrientationPropertyDefinition
Field Value
StylePropertyDefinition<System.Nullable<PageOrientation>>

PageSizePropertyDefinition

Gets the page size property definition.

Declaration
public static readonly StylePropertyDefinition<Size? > PageSizePropertyDefinition
Field Value
StylePropertyDefinition<System.Nullable<System.Windows.Size>>

SectionTypePropertyDefinition

Gets the section type property definition.

Declaration
public static readonly StylePropertyDefinition<SectionType? > SectionTypePropertyDefinition
Field Value
StylePropertyDefinition<System.Nullable<SectionType>>

StartingPageNumberPropertyDefinition

Gets the starting page number property definition.

Declaration
public static readonly StylePropertyDefinition<int? > StartingPageNumberPropertyDefinition
Field Value
StylePropertyDefinition<System.Nullable<System.Int32>>

VerticalAlignmentPropertyDefinition

Gets the vertical alignment property definition.

Declaration
public static readonly StylePropertyDefinition<VerticalAlignment> VerticalAlignmentPropertyDefinition
Field Value
StylePropertyDefinition<VerticalAlignment>

Properties

FooterBottomMargin

Gets or sets the bottom margin of the footer. The value is in device independent pixels (1/96 inch).

Declaration
public double FooterBottomMargin { get; set; }
Property Value
System.Double

The footer bottom margin.

Footers

Gets all footers associated to this section.

Declaration
public Footers Footers { get; }
Property Value
Footers

The footers.

HasDifferentFirstPageHeaderFooter

Gets or sets a value indicating if the section has different header/footer for its first page.

Declaration
public bool HasDifferentFirstPageHeaderFooter { get; set; }
Property Value
System.Boolean

The default value is false.

Headers

Gets all headers associated to this section.

Declaration
public Headers Headers { get; }
Property Value
Headers

The headers.

HeaderTopMargin

Gets or sets the top margin of the header. The value is in device independent pixels (1/96 inch).

Declaration
public double HeaderTopMargin { get; set; }
Property Value
System.Double

The header top margin.

PageMargins

Gets or sets the page margins.

Declaration
public Padding PageMargins { get; set; }
Property Value
Padding

The page margins.

PageNumberingSettings

Gets the page numbering settings.

Declaration
public PageNumberingSettings PageNumberingSettings { get; }
Property Value
PageNumberingSettings

The page numbering settings.

PageOrientation

Gets or sets the page orientation. Specifies the actual paper size to use when printing the file.

Declaration
public PageOrientation PageOrientation { get; set; }
Property Value
PageOrientation

The page orientation.

PageSize

Gets or sets the size of the page. The width and height are in device independent pixels (1/96 inch).

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

Gets the styling properties of this element.

Declaration
public SectionProperties Properties { get; }
Property Value
SectionProperties

The properties.

SectionType

Gets or sets the type of the section.

Declaration
public SectionType SectionType { get; set; }
Property Value
SectionType

The type of the section.

VerticalAlignment

Gets or sets the vertical alignment.

Declaration
public VerticalAlignment VerticalAlignment { get; set; }
Property Value
VerticalAlignment

The vertical alignment.

Methods

Clone()

Creates deep copy of this document element, associated to the current document.

Declaration
public Section Clone()
Returns
Section

The cloned element.

Clone(RadFlowDocument)

Creates deep copy of this document element, associated to document.

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)

Rotates the page orientation and changes the size and margins of the related section.

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

Extension Methods