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
Defines the layout-affecting style property that stores a section's text-column arrangement.
public static readonly StylePropertyDefinition<SectionColumnCollection, SectionProperties> ColumnsProperty
Defines the layout-affecting style property for the first endnote reference number; unset section values inherit EndnotesFirstNumber.
public static readonly StylePropertyDefinition<int?, SectionProperties> EndnotesFirstNumberProperty
Defines the layout-affecting style property for endnote reference markers; unset section values inherit EndnotesNumberingFormat.
public static readonly StylePropertyDefinition<ListNumberingFormat?, SectionProperties> EndnotesNumberingFormatProperty
Defines the layout-affecting style property for endnote numbering restarts; unset section values inherit EndnotesNumberingRestartType.
public static readonly StylePropertyDefinition<NumberingRestartType?, SectionProperties> EndnotesNumberingRestartTypeProperty
Defines the layout-affecting style property for the inset below footer content in a section.
public static readonly StylePropertyDefinition<int?, SectionProperties> FooterBottomMarginProperty
Defines the layout-affecting style property for the first footnote reference number; unset section values inherit FootnotesFirstNumber.
public static readonly StylePropertyDefinition<int?, SectionProperties> FootnotesFirstNumberProperty
Defines the layout-affecting style property for footnote reference markers; unset section values inherit FootnotesNumberingFormat.
public static readonly StylePropertyDefinition<ListNumberingFormat?, SectionProperties> FootnotesNumberingFormatProperty
Defines the layout-affecting style property for footnote numbering restarts; unset section values inherit FootnotesNumberingRestartType.
public static readonly StylePropertyDefinition<NumberingRestartType?, SectionProperties> FootnotesNumberingRestartTypeProperty
Defines the layout-affecting property that controls whether this section uses separate headers and footers on its first page.
public static readonly StylePropertyDefinition<bool?, SectionProperties> HasDifferentFirstPageHeaderFooterProperty
Defines the layout-affecting style property for the inset above header content in a section.
public static readonly StylePropertyDefinition<int?, SectionProperties> HeaderTopMarginProperty
Defines the layout-affecting style property for line-numbering settings in a section.
public static readonly StylePropertyDefinition<LineNumbering, SectionProperties> LineNumberingProperty
Defines the layout-affecting style property for a section's page margins.
public static readonly StylePropertyDefinition<Padding?, SectionProperties> PageMarginProperty
Defines the layout-affecting style property for a section's page orientation.
public static readonly StylePropertyDefinition<PageOrientation?, SectionProperties> PageOrientationProperty
Defines the layout-affecting style property for a section's page dimensions.
public static readonly StylePropertyDefinition<Size?, SectionProperties> PageSizeProperty
Defines the layout-affecting style property that records how the section starts relative to the preceding section.
public static readonly StylePropertyDefinition<SectionBreakType?, SectionProperties> PreviousSectionBreakTypeProperty
Properties
Gets or sets the page margins after they have been mapped to the section's current PageOrientation. Use PageMargin for the stored margin values before orientation adjustment.
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.
Gets or sets the section's page margins before orientation adjustment. If not overridden, the value resolves from SectionDefaultPageMargin. Use ActualPageMargin for margins mapped to the current orientation.
[XamlSerializable]
public Padding PageMargin { get; set; }
Gets or sets the orientation used to lay out this section. It determines how page dimensions and margin sides are mapped; if not overridden, the value resolves from SectionDefaultPageOrientation.
[XamlSerializable(PageOrientation.Portrait)]
public PageOrientation PageOrientation { get; set; }
Gets or sets the section's page dimensions before orientation adjustment. If not overridden, the value resolves from SectionDefaultPageSize.
[XamlSerializable]
public Size PageSize { get; set; }
Gets or sets the break used to enter this section from the preceding section. The default is NextPage.
[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.
Currently performs no work after a child document container changes.
public void OnChildDocumentContainerChanged()
Currently performs no work before a child document container changes.
public void OnChildDocumentContainerChanging()
Notifies the root document and section listeners after header/footer settings change.
protected virtual void OnHeadersFootersChanged(EventArgs e)
Event data for the notification.
Refreshes header/footer document ownership and protection settings after the section is reparented.
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.