Class Section

A block-level flow content element used for grouping other Block elements.

Inheritance
System.Object
DocumentElement
Block
BlockContainerBase
Section
Inherited Members
Namespace: Telerik.Windows.Documents.Model
Assembly: Telerik.Windows.Documents.dll

Syntax

public class Section : BlockContainerBase, IBlockContainer, IContainChildDocument

Constructors

Section()

Initializes a new instance of the Section class.

Declaration
public Section()

Section(Section)

Initializes a new instance of the Section class by copying the properties from another instance.

Declaration
public Section(Section originalSection)
Parameters
Section originalSection

The original section.

Fields

ColumnsProperty

Declaration
public static readonly StylePropertyDefinition<SectionColumnCollection, SectionProperties> ColumnsProperty
Field Value
StylePropertyDefinition<SectionColumnCollection, SectionProperties>

EndnotesFirstNumberProperty

Declaration
public static readonly StylePropertyDefinition<Nullable<int>, SectionProperties> EndnotesFirstNumberProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Int32>, SectionProperties>

EndnotesNumberingFormatProperty

Declaration
public static readonly StylePropertyDefinition<Nullable<ListNumberingFormat>, SectionProperties> EndnotesNumberingFormatProperty
Field Value
StylePropertyDefinition<System.Nullable<ListNumberingFormat>, SectionProperties>

EndnotesNumberingRestartTypeProperty

Declaration
public static readonly StylePropertyDefinition<Nullable<NumberingRestartType>, SectionProperties> EndnotesNumberingRestartTypeProperty
Field Value
StylePropertyDefinition<System.Nullable<NumberingRestartType>, SectionProperties>

FooterBottomMarginProperty

Declaration
public static readonly StylePropertyDefinition<Nullable<int>, SectionProperties> FooterBottomMarginProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Int32>, SectionProperties>

FootnotesFirstNumberProperty

Declaration
public static readonly StylePropertyDefinition<Nullable<int>, SectionProperties> FootnotesFirstNumberProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Int32>, SectionProperties>

FootnotesNumberingFormatProperty

Declaration
public static readonly StylePropertyDefinition<Nullable<ListNumberingFormat>, SectionProperties> FootnotesNumberingFormatProperty
Field Value
StylePropertyDefinition<System.Nullable<ListNumberingFormat>, SectionProperties>

FootnotesNumberingRestartTypeProperty

Declaration
public static readonly StylePropertyDefinition<Nullable<NumberingRestartType>, SectionProperties> FootnotesNumberingRestartTypeProperty
Field Value
StylePropertyDefinition<System.Nullable<NumberingRestartType>, SectionProperties>

HasDifferentFirstPageHeaderFooterProperty

Declaration
public static readonly StylePropertyDefinition<Nullable<bool>, SectionProperties> HasDifferentFirstPageHeaderFooterProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Boolean>, SectionProperties>

HeaderTopMarginProperty

Declaration
public static readonly StylePropertyDefinition<Nullable<int>, SectionProperties> HeaderTopMarginProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Int32>, SectionProperties>

PageMarginProperty

Declaration
public static readonly StylePropertyDefinition<Nullable<Padding>, SectionProperties> PageMarginProperty
Field Value
StylePropertyDefinition<System.Nullable<Padding>, SectionProperties>

PageOrientationProperty

Declaration
public static readonly StylePropertyDefinition<Nullable<PageOrientation>, SectionProperties> PageOrientationProperty
Field Value
StylePropertyDefinition<System.Nullable<Telerik.Windows.Documents.Model.PageOrientation>, SectionProperties>

PageSizeProperty

Declaration
public static readonly StylePropertyDefinition<Nullable<Size>, SectionProperties> PageSizeProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Windows.Size>, SectionProperties>

PreviousSectionBreakTypeProperty

Declaration
public static readonly StylePropertyDefinition<Nullable<SectionBreakType>, SectionProperties> PreviousSectionBreakTypeProperty
Field Value
StylePropertyDefinition<System.Nullable<SectionBreakType>, SectionProperties>

Properties

ActualPageMargin

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

Columns

Gets or sets the text columns in the Section.

Declaration
public SectionColumnCollection Columns { get; set; }
Property Value
SectionColumnCollection

The section columns.

ColumnsSerializationData

This property supports XAML serialization infrastructure and is not intended to be used directly from your code.

Declaration
[XamlCompositePropertySerializable]
public SectionColumnCollectionSerializationData ColumnsSerializationData { get; set; }
Property Value
SectionColumnCollectionSerializationData

EndnotesFirstNumber

Gets or sets the endnotes starting number.

Declaration
[XamlSerializable(1)]
public int EndnotesFirstNumber { get; set; }
Property Value
System.Int32

EndnotesNumberingFormat

Gets or sets the endnotes numbering format.

Declaration
[XamlSerializable]
public ListNumberingFormat EndnotesNumberingFormat { get; set; }
Property Value
ListNumberingFormat

EndnotesNumberingRestartType

Gets or sets the type of the endnotes numbering restart.

Declaration
[XamlSerializable]
public NumberingRestartType EndnotesNumberingRestartType { get; set; }
Property Value
NumberingRestartType

FirstPageNumber

Gets or sets the page number that appears on the first page of the section.

Declaration
[XamlSerializable(null)]
public Nullable<int> FirstPageNumber { get; set; }
Property Value
System.Nullable<System.Int32>

The page number.

FooterBottomMargin

Gets or sets the footer bottom margin.

Declaration
[XamlSerializable(48)]
public int FooterBottomMargin { get; set; }
Property Value
System.Int32

The footer bottom margin.

Footers

Gets or sets the footers.

Declaration
[XamlCompositePropertySerializable]
public Footers Footers { get; set; }
Property Value
Footers

The footers.

FootnotesFirstNumber

Gets or sets the footnotes starting number.

Declaration
[XamlSerializable(1)]
public int FootnotesFirstNumber { get; set; }
Property Value
System.Int32

FootnotesNumberingFormat

Gets or sets the footnotes numbering format.

Declaration
[XamlSerializable]
public ListNumberingFormat FootnotesNumberingFormat { get; set; }
Property Value
ListNumberingFormat

FootnotesNumberingRestartType

Gets or sets the type of the footnotes numbering restart.

Declaration
[XamlSerializable]
public NumberingRestartType FootnotesNumberingRestartType { get; set; }
Property Value
NumberingRestartType

HasDifferentFirstPageHeaderFooter

Gets or sets a value indicating whether first page header/footer is different.

Declaration
[XamlSerializable(false)]
public bool HasDifferentFirstPageHeaderFooter { get; set; }
Property Value
System.Boolean

true if first page header/footer is different; otherwise, false.

Headers

Gets or sets the headers.

Declaration
[XamlCompositePropertySerializable]
public Headers Headers { get; set; }
Property Value
Headers

The headers.

HeaderTopMargin

Gets or sets the header top margin.

Declaration
[XamlSerializable(48)]
public int HeaderTopMargin { get; set; }
Property Value
System.Int32

The header top margin.

IsEmpty

Gets a value indicating whether the section is empty.

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

true if the section is empty; otherwise, false.

Number

Gets the section number (starting from 1).

Declaration
public int Number { get; }
Property Value
System.Int32

PageMargin

Declaration
[XamlSerializable]
public Padding PageMargin { get; set; }
Property Value
Padding

PageOrientation

Declaration
[XamlSerializable]
public PageOrientation PageOrientation { get; set; }
Property Value
Telerik.Windows.Documents.Model.PageOrientation

PageSize

Declaration
[XamlSerializable]
public Size PageSize { get; set; }
Property Value
System.Windows.Size

PreviousSectionBreakType

Declaration
[XamlSerializable]
public SectionBreakType PreviousSectionBreakType { get; set; }
Property Value
SectionBreakType

Methods

CopyPropertiesFromOverride(DocumentElement)

Copies the properties from another document element to the current instance.

Declaration
protected override void CopyPropertiesFromOverride(DocumentElement fromElement)
Parameters
DocumentElement fromElement

The Section to copy the properties from.
Overrides

CreateLayoutBox(DocumentStructureCollection)

Creates a SectionLayoutBox for the element.

Declaration
public override LayoutBox CreateLayoutBox(DocumentStructureCollection documentCollection)
Parameters
DocumentStructureCollection documentCollection

The document collection.
Returns
LayoutBox

The new SectionLayoutBox.
Overrides

CreateNewElementInstance()

Creates a new Section instance.

Declaration
protected override DocumentElement CreateNewElementInstance()
Returns
DocumentElement

The new instance.
Overrides

GetFooterByPageNumber(Int32)

Gets the footer by page number.

Declaration
public Footer GetFooterByPageNumber(int pageNumber)
Parameters
System.Int32 pageNumber

The page number.
Returns
Footer

GetFooterByType(HeaderFooterType)

Gets the footer by its type.

Declaration
public Footer GetFooterByType(HeaderFooterType footerType)
Parameters
HeaderFooterType footerType

Type of the footer.
Returns
Footer

GetFooterHeight(Int32)

Gets the height of the footer for a page.

Declaration
public float GetFooterHeight(int pageNumber)
Parameters
System.Int32 pageNumber

The page number.
Returns
System.Single

GetHeaderByPageNumber(Int32)

Gets the header by page number.

Declaration
public Header GetHeaderByPageNumber(int pageNumber)
Parameters
System.Int32 pageNumber

The page number.
Returns
Header

GetHeaderByType(HeaderFooterType)

Gets the header by its type.

Declaration
public Header GetHeaderByType(HeaderFooterType headerType)
Parameters
HeaderFooterType headerType

Type of the header.
Returns
Header

GetHeaderFooterTypeByPageNumber(Int32)

Gets the header/footer type by page number.

Declaration
public HeaderFooterType GetHeaderFooterTypeByPageNumber(int pageNumber)
Parameters
System.Int32 pageNumber

The page number.
Returns
HeaderFooterType

GetHeaderHeight(Int32)

Gets the height of the header for a page.

Declaration
public float GetHeaderHeight(int pageNumber)
Parameters
System.Int32 pageNumber

The page number.
Returns
System.Single

IsFooterLinkedToPrevious(HeaderFooterType)

Determines whether a footer is linked to the previous section footer.

Declaration
public bool IsFooterLinkedToPrevious(HeaderFooterType headerFooterType)
Parameters
HeaderFooterType headerFooterType

Type of the footer.
Returns
System.Boolean

true if the footer is linked to the previous section footer; otherwise, false.

IsHeaderLinkedToPrevious(HeaderFooterType)

Determines whether a header is linked to the previous section header.

Declaration
public bool IsHeaderLinkedToPrevious(HeaderFooterType headerFooterType)
Parameters
HeaderFooterType headerFooterType

Type of the header.
Returns
System.Boolean

true if the header is linked to the previous section header; otherwise, false.

LinkFooterToPrevious(HeaderFooterType)

Links the footer of this section to the previous section footer.

Declaration
public void LinkFooterToPrevious(HeaderFooterType headerFooterType)
Parameters
HeaderFooterType headerFooterType

Type of the header or footer.

LinkHeaderToPrevious(HeaderFooterType)

Links the header of this section to the previous section header.

Declaration
public void LinkHeaderToPrevious(HeaderFooterType headerFooterType)
Parameters
HeaderFooterType headerFooterType

Type of the header or footer.

OnChildDocumentContainerChanged()

Declaration
public void OnChildDocumentContainerChanged()

OnChildDocumentContainerChanging()

Declaration
public void OnChildDocumentContainerChanging()

OnHeadersFootersChanged(EventArgs)

Declaration
protected virtual void OnHeadersFootersChanged(EventArgs e)
Parameters
System.EventArgs e

OnParentChanged()

Declaration
protected override void OnParentChanged()
Overrides

SetFooterByPageNumber(Int32, Footer)

Sets the footer by page number.

Declaration
public void SetFooterByPageNumber(int pageNumber, Footer footer)
Parameters
System.Int32 pageNumber

The page number.
Footer footer

The footer.

SetFooterByType(HeaderFooterType, Footer)

Sets a footer according to type.

Declaration
public void SetFooterByType(HeaderFooterType footerType, Footer footer)
Parameters
HeaderFooterType footerType

Type of the footer.
Footer footer

The footer.

SetHeaderByPageNumber(Int32, Header)

Sets the header by page number.

Declaration
public void SetHeaderByPageNumber(int pageNumber, Header header)
Parameters
System.Int32 pageNumber

The page number.
Header header

The header.

SetHeaderByType(HeaderFooterType, Header)

Sets a header according to type.

Declaration
public void SetHeaderByType(HeaderFooterType headerType, Header header)
Parameters
HeaderFooterType headerType

Type of the header.
Header header

The header.

SetMainDocument(RadDocument)

Sets the main document. This method is used to link the headers and footers in a section with the main body document.

Declaration
public void SetMainDocument(RadDocument document)
Parameters
RadDocument document

The document.

UnlinkFooterFromPrevious(HeaderFooterType)

Removes the link between the footer of this section and the previous section footer.

Declaration
public void UnlinkFooterFromPrevious(HeaderFooterType headerFooterType)
Parameters
HeaderFooterType headerFooterType

Type of the header or footer.

UnlinkHeaderFromPrevious(HeaderFooterType)

Removes the link between the header of this section and the previous section header.

Declaration
public void UnlinkHeaderFromPrevious(HeaderFooterType headerFooterType)
Parameters
HeaderFooterType headerFooterType

Type of the header or footer.

Extension Methods