ClassSection
A block-level flow content element used for grouping other Block elements.
Definition
Namespace:Telerik.Windows.Documents.Model
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public class Section : BlockContainerBase, IBlockContainerInheritance: objectDocumentElementBlockBlockContainerBaseSection
Implements:
Inherited Members
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
originalSection
The original section.
Fields
ColumnsProperty
Declaration
public static readonly StylePropertyDefinition<SectionColumnCollection, SectionProperties> ColumnsPropertyField Value
StylePropertyDefinition<SectionColumnCollection, SectionProperties>
EndnotesFirstNumberProperty
Declaration
public static readonly StylePropertyDefinition<int?, SectionProperties> EndnotesFirstNumberPropertyField Value
EndnotesNumberingFormatProperty
Declaration
public static readonly StylePropertyDefinition<ListNumberingFormat?, SectionProperties> EndnotesNumberingFormatPropertyField Value
StylePropertyDefinition<ListNumberingFormat?, SectionProperties>
EndnotesNumberingRestartTypeProperty
Declaration
public static readonly StylePropertyDefinition<NumberingRestartType?, SectionProperties> EndnotesNumberingRestartTypePropertyField Value
StylePropertyDefinition<NumberingRestartType?, SectionProperties>
FooterBottomMarginProperty
Declaration
public static readonly StylePropertyDefinition<int?, SectionProperties> FooterBottomMarginPropertyField Value
FootnotesFirstNumberProperty
Declaration
public static readonly StylePropertyDefinition<int?, SectionProperties> FootnotesFirstNumberPropertyField Value
FootnotesNumberingFormatProperty
Declaration
public static readonly StylePropertyDefinition<ListNumberingFormat?, SectionProperties> FootnotesNumberingFormatPropertyField Value
StylePropertyDefinition<ListNumberingFormat?, SectionProperties>
FootnotesNumberingRestartTypeProperty
Declaration
public static readonly StylePropertyDefinition<NumberingRestartType?, SectionProperties> FootnotesNumberingRestartTypePropertyField Value
StylePropertyDefinition<NumberingRestartType?, SectionProperties>
HasDifferentFirstPageHeaderFooterProperty
Declaration
public static readonly StylePropertyDefinition<bool?, SectionProperties> HasDifferentFirstPageHeaderFooterPropertyField Value
HeaderTopMarginProperty
Declaration
public static readonly StylePropertyDefinition<int?, SectionProperties> HeaderTopMarginPropertyField Value
LineNumberingProperty
Declaration
public static readonly StylePropertyDefinition<LineNumbering, SectionProperties> LineNumberingPropertyField Value
PageMarginProperty
Declaration
public static readonly StylePropertyDefinition<Padding?, SectionProperties> PageMarginPropertyField Value
PageOrientationProperty
Declaration
public static readonly StylePropertyDefinition<PageOrientation?, SectionProperties> PageOrientationPropertyField Value
StylePropertyDefinition<PageOrientation?, SectionProperties>
PageSizeProperty
Declaration
public static readonly StylePropertyDefinition<Size?, SectionProperties> PageSizePropertyField Value
PreviousSectionBreakTypeProperty
Declaration
public static readonly StylePropertyDefinition<SectionBreakType?, SectionProperties> PreviousSectionBreakTypePropertyField Value
StylePropertyDefinition<SectionBreakType?, SectionProperties>
Properties
ActualPageMargin
Represents the actual margin of a page in a document.
Columns
Gets or sets the text columns in the Section.
Declaration
public SectionColumnCollection Columns { get; set; }Property Value
The section columns.
EndnotesFirstNumber
Gets or sets the endnotes starting number.
Declaration
[XamlSerializable(1)]
public int EndnotesFirstNumber { get; set; }Property Value
EndnotesNumberingFormat
Gets or sets the endnotes numbering format.
Declaration
[XamlSerializable(ListNumberingFormat.Decimal)]
public ListNumberingFormat EndnotesNumberingFormat { get; set; }Property Value
EndnotesNumberingRestartType
Gets or sets the type of the endnotes numbering restart.
Declaration
[XamlSerializable(NumberingRestartType.Continuous)]
public NumberingRestartType EndnotesNumberingRestartType { get; set; }Property Value
FirstPageNumber
Gets or sets the page number that appears on the first page of the section.
Declaration
[XamlSerializable(null)]
public int? FirstPageNumber { get; set; }Property Value
int?
The page number.
FooterBottomMargin
Gets or sets the footer bottom margin.
Declaration
[XamlSerializable(48)]
public int FooterBottomMargin { get; set; }Property Value
The footer bottom margin.
Footers
Gets or sets the footers.
Declaration
[XamlCompositePropertySerializable]
public Footers Footers { get; set; }Property Value
The footers.
FootnotesFirstNumber
Gets or sets the footnotes starting number.
Declaration
[XamlSerializable(1)]
public int FootnotesFirstNumber { get; set; }Property Value
FootnotesNumberingFormat
Gets or sets the footnotes numbering format.
Declaration
[XamlSerializable(ListNumberingFormat.Decimal)]
public ListNumberingFormat FootnotesNumberingFormat { get; set; }Property Value
FootnotesNumberingRestartType
Gets or sets the type of the footnotes numbering restart.
Declaration
[XamlSerializable(NumberingRestartType.Continuous)]
public NumberingRestartType FootnotesNumberingRestartType { get; set; }Property Value
HasDifferentFirstPageHeaderFooter
Gets or sets a value indicating whether first page header/footer is different.
Declaration
[XamlSerializable(false)]
public bool HasDifferentFirstPageHeaderFooter { get; set; }Property Value
true if first page header/footer is different; otherwise, false.
HeaderTopMargin
Gets or sets the header top margin.
Declaration
[XamlSerializable(48)]
public int HeaderTopMargin { get; set; }Property Value
The header top margin.
Headers
Gets or sets the headers.
Declaration
[XamlCompositePropertySerializable]
public Headers Headers { get; set; }Property Value
The headers.
IsEmpty
Gets a value indicating whether the section is empty.
Declaration
public bool IsEmpty { get; }Property Value
true if the section is empty; otherwise, false.
LineNumbering
Gets or sets the line numbering in the Section.
Declaration
public LineNumbering LineNumbering { get; set; }Property Value
The line numbering.
Number
Gets the section number (starting from 1).
PageMargin
Represents the page margin settings for a document section in the Telerik Windows Document Model.
Declaration
[XamlSerializable]
public Padding PageMargin { get; set; }Property Value
PageOrientation
Represents the orientation of a page in a document.
Declaration
[XamlSerializable]
public PageOrientation PageOrientation { get; set; }Property Value
PageOrientation
PageSize
Gets or sets the size of the page for the document section.
Declaration
[XamlSerializable]
public Size PageSize { get; set; }Property Value
Size
A Size representing the width and height of the page.
PreviousSectionBreakType
Gets or sets the type of the previous section break for the document section.
Declaration
[XamlSerializable]
public SectionBreakType PreviousSectionBreakType { get; set; }Property Value
A PreviousSectionBreakType value that indicates the type of break preceding the section.
Methods
CopyPropertiesFromOverride(DocumentElement)
Copies the properties from another document element to the current instance.
Declaration
protected override void CopyPropertiesFromOverride(DocumentElement fromElement)Parameters
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
documentCollection
The document collection.
Returns
The new SectionLayoutBox.
Overrides
CreateNewElementInstance()
Creates a new Section instance.
Declaration
protected override DocumentElement CreateNewElementInstance()Returns
The new instance.
Overrides
GetFooterByPageNumber(int)
Gets the footer by page number.
GetFooterByType(HeaderFooterType)
Gets the footer by its type.
Declaration
public Footer GetFooterByType(HeaderFooterType footerType)Parameters
footerType
Type of the footer.
Returns
GetFooterHeight(int)
Gets the height of the footer for a page.
GetHeaderByPageNumber(int)
Gets the header by page number.
GetHeaderByType(HeaderFooterType)
Gets the header by its type.
Declaration
public Header GetHeaderByType(HeaderFooterType headerType)Parameters
headerType
Type of the header.
Returns
GetHeaderFooterTypeByPageNumber(int)
Gets the header/footer type by page number.
Declaration
public HeaderFooterType GetHeaderFooterTypeByPageNumber(int pageNumber)Parameters
pageNumber
The page number.
Returns
GetHeaderHeight(int)
Gets the height of the header for a page.
IsFooterLinkedToPrevious(HeaderFooterType)
Determines whether a footer is linked to the previous section footer.
Declaration
public bool IsFooterLinkedToPrevious(HeaderFooterType headerFooterType)Parameters
headerFooterType
Type of the footer.
Returns
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
Type of the header.
Returns
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
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
Type of the header or footer.
OnChildDocumentContainerChanged()
Occurs when the child document container has changed.
Declaration
public void OnChildDocumentContainerChanged()OnChildDocumentContainerChanging()
Occurs when the child document container is about to change.
Declaration
public void OnChildDocumentContainerChanging()OnHeadersFootersChanged(EventArgs)
Declaration
protected virtual void OnHeadersFootersChanged(EventArgs e)Parameters
e
OnParentChanged()
Called when the parent of the element has been changed.
Declaration
protected override void OnParentChanged()Overrides
SetFooterByPageNumber(int, Footer)
Sets the footer by page number.
SetFooterByType(HeaderFooterType, Footer)
Sets a footer according to type.
Declaration
public void SetFooterByType(HeaderFooterType footerType, Footer footer)Parameters
footerType
Type of the footer.
footer
The footer.
SetHeaderByPageNumber(int, Header)
Sets the header by page number.
SetHeaderByType(HeaderFooterType, Header)
Sets a header according to type.
Declaration
public void SetHeaderByType(HeaderFooterType headerType, Header header)Parameters
headerType
Type of the 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
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
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
Type of the header or footer.