Section
A block-level flow content element used for grouping other Block elements.
Definition
Namespace:Telerik.WinForms.Documents.Model
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class Section : BlockContainerBase, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, IBlockContainer
Inheritance: objectDisposableObjectRadObjectDocumentElementBlockBlockContainerBaseSection...
Implements:
Inherited Members
Constructors
Fields
public static readonly StylePropertyDefinition<SectionColumnCollection, SectionProperties> ColumnsProperty
public static readonly StylePropertyDefinition<int?, SectionProperties> EndnotesFirstNumberProperty
public static readonly StylePropertyDefinition<ListNumberingFormat?, SectionProperties> EndnotesNumberingFormatProperty
public static readonly StylePropertyDefinition<NumberingRestartType?, SectionProperties> EndnotesNumberingRestartTypeProperty
public static readonly StylePropertyDefinition<int?, SectionProperties> FooterBottomMarginProperty
public static readonly StylePropertyDefinition<int?, SectionProperties> FootnotesFirstNumberProperty
public static readonly StylePropertyDefinition<ListNumberingFormat?, SectionProperties> FootnotesNumberingFormatProperty
public static readonly StylePropertyDefinition<NumberingRestartType?, SectionProperties> FootnotesNumberingRestartTypeProperty
public static readonly StylePropertyDefinition<bool?, SectionProperties> HasDifferentFirstPageHeaderFooterProperty
public static readonly StylePropertyDefinition<int?, SectionProperties> HeaderTopMarginProperty
public static readonly StylePropertyDefinition<LineNumbering, SectionProperties> LineNumberingProperty
public static readonly StylePropertyDefinition<Padding?, SectionProperties> PageMarginProperty
public static readonly StylePropertyDefinition<PageOrientation?, SectionProperties> PageOrientationProperty
public static readonly StylePropertyDefinition<Size?, SectionProperties> PageSizeProperty
public static readonly StylePropertyDefinition<SectionBreakType?, SectionProperties> PreviousSectionBreakTypeProperty
Properties
public Padding ActualPageMargin { get; set; }
Gets or sets the text columns in the Section.
public SectionColumnCollection Columns { get; set; }
The section columns.
Gets or sets the endnotes starting number.
[XamlSerializable(1)]
public int EndnotesFirstNumber { get; set; }
Gets or sets the endnotes numbering format.
[XamlSerializable(ListNumberingFormat.Decimal)]
public ListNumberingFormat EndnotesNumberingFormat { get; set; }
Gets or sets the type of the endnotes numbering restart.
[XamlSerializable(NumberingRestartType.Continuous)]
public NumberingRestartType EndnotesNumberingRestartType { get; set; }
Gets or sets the page number that appears on the first page of the section.
[XamlSerializable(null)]
public int? FirstPageNumber { get; set; }
The page number.
Gets or sets the footer bottom margin.
[XamlSerializable(48)]
public int FooterBottomMargin { get; set; }
The footer bottom margin.
Gets or sets the footers.
[XamlCompositePropertySerializable]
public Footers Footers { get; set; }
The footers.
Gets or sets the footnotes starting number.
[XamlSerializable(1)]
public int FootnotesFirstNumber { get; set; }
Gets or sets the footnotes numbering format.
[XamlSerializable(ListNumberingFormat.Decimal)]
public ListNumberingFormat FootnotesNumberingFormat { get; set; }
Gets or sets the type of the footnotes numbering restart.
[XamlSerializable(NumberingRestartType.Continuous)]
public NumberingRestartType FootnotesNumberingRestartType { get; set; }
Gets or sets a value indicating whether first page header/footer is different.
[XamlSerializable(false)]
public bool HasDifferentFirstPageHeaderFooter { get; set; }
true if first page header/footer is different; otherwise, false.
Gets or sets the headers.
[XamlCompositePropertySerializable]
public Headers Headers { get; set; }
The headers.
Gets or sets the header top margin.
[XamlSerializable(48)]
public int HeaderTopMargin { get; set; }
The header top margin.
Gets a value indicating whether the section is empty.
public bool IsEmpty { get; }
true if the section is empty; otherwise, false.
Gets or sets the line numbering in the Section.
public LineNumbering LineNumbering { get; set; }
The line numbering.
[XamlSerializable]
public Padding PageMargin { get; set; }
[XamlSerializable(PageOrientation.Portrait)]
public PageOrientation PageOrientation { get; set; }
[XamlSerializable]
public SectionBreakType PreviousSectionBreakType { get; set; }
Methods
Copies the properties from another document element to the current instance.
protected override void CopyPropertiesFromOverride(DocumentElement fromElement)
The Section to copy the properties from.
Overrides:
Creates a SectionLayoutBox for the element.
public override LayoutBox CreateLayoutBox(DocumentStructureCollection documentCollection)
The document collection.
Returns:The new SectionLayoutBox.
Overrides:
Creates a new Section instance.
protected override DocumentElement CreateNewElementInstance()
The new instance.
Overrides:
Gets the footer by its type.
public Footer GetFooterByType(HeaderFooterType footerType)
Type of the footer.
Returns:Gets the header by its type.
public Header GetHeaderByType(HeaderFooterType headerType)
Type of the header.
Returns:Gets the header/footer type by page number.
public HeaderFooterType GetHeaderFooterTypeByPageNumber(int pageNumber)
The page number.
Returns:Determines whether a footer is linked to the previous section footer.
public bool IsFooterLinkedToPrevious(HeaderFooterType headerFooterType)
Type of the footer.
Returns:true if the footer is linked to the previous section footer; otherwise, false.
Determines whether a header is linked to the previous section header.
public bool IsHeaderLinkedToPrevious(HeaderFooterType headerFooterType)
Type of the header.
Returns:true if the header is linked to the previous section header; otherwise, false.
Links the footer of this section to the previous section footer.
public void LinkFooterToPrevious(HeaderFooterType headerFooterType)
Type of the header or footer.
Links the header of this section to the previous section header.
public void LinkHeaderToPrevious(HeaderFooterType headerFooterType)
Type of the header or footer.
public void OnChildDocumentContainerChanged()
public void OnChildDocumentContainerChanging()
Called when the parent of the element has been changed.
protected override void OnParentChanged()
Overrides:
Sets a footer according to type.
public void SetFooterByType(HeaderFooterType footerType, Footer footer)
Type of the footer.
footerFooterThe footer.
Sets a header according to type.
public void SetHeaderByType(HeaderFooterType headerType, Header header)
Type of the header.
headerHeaderThe header.
Sets the main document. This method is used to link the headers and footers in a section with the main body document.
Removes the link between the footer of this section and the previous section footer.
public void UnlinkFooterFromPrevious(HeaderFooterType headerFooterType)
Type of the header or footer.
Removes the link between the header of this section and the previous section header.
public void UnlinkHeaderFromPrevious(HeaderFooterType headerFooterType)
Type of the header or footer.