Class SelectionSectionFormatModule

Represents the selection section format module in DocumentEditor.

Inheritance

System.Object

SelectionSectionFormatModule

Namespace: Syncfusion.Blazor.DocumentEditor

Assembly: Syncfusion.Blazor.DocumentEditor.dll

Syntax

public class SelectionSectionFormatModule : Object

Constructors

SelectionSectionFormatModule(SfDocumentEditor)

Initializes a new instance of the SelectionSectionFormatModule class. Default constructor for SelectionSectionFormatModule.

Declaration

public SelectionSectionFormatModule(SfDocumentEditor baseComponent)

Parameters

Type	Name	Description
SfDocumentEditor	baseComponent	An DocumentEdiorComponent instance.

Properties

DocumentEditor

DocumentEdiorComponent instance.

Declaration

protected SfDocumentEditor DocumentEditor { get; set; }

Property Value

Type
SfDocumentEditor

EvenPageFooter

Gets the even page footer of the section.

Declaration

public SelectionHeaderFooter EvenPageFooter { get; }

Property Value

Type	Description
SelectionHeaderFooter	Returns the even page footer instance.

EvenPageHeader

Gets the even page header of the section.

Declaration

public SelectionHeaderFooter EvenPageHeader { get; }

Property Value

Type	Description
SelectionHeaderFooter	Returns the even page header instance.

FirstPageFooter

Gets the first page footer of the section.

Declaration

public SelectionHeaderFooter FirstPageFooter { get; }

Property Value

Type	Description
SelectionHeaderFooter	Returns the first page footer instance.

FirstPageHeader

Gets the first page header of the section.

Declaration

public SelectionHeaderFooter FirstPageHeader { get; }

Property Value

Type	Description
SelectionHeaderFooter	Returns the first page header instance.

OddPageFooter

Gets the odd page footer of the section.

Declaration

public SelectionHeaderFooter OddPageFooter { get; }

Property Value

Type	Description
SelectionHeaderFooter	Returns the odd page footer instance.

OddPageHeader

Gets the odd page header of the section.

Declaration

public SelectionHeaderFooter OddPageHeader { get; }

Property Value

Type	Description
SelectionHeaderFooter	Returns the odd page header instance.

Methods

GetBottomMarginAsync()

Gets or sets the page bottom margin.

Declaration

public Task<int> GetBottomMarginAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetBottomMarginDoubleAsync()

Gets or sets the page bottom margin.

Declaration

public Task<double> GetBottomMarginDoubleAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetColumns()

Gets or sets the columns.

Declaration

public Task<SelectionColumnFormat[]> GetColumns()

Returns

Type	Description
System.Threading.Tasks.Task<SelectionColumnFormat[]>	Returns the collection of columns

GetDifferentFirstPageAsync()

Gets or sets a value indicating whether the section has different first page.

Declaration

public Task<bool> GetDifferentFirstPageAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetDifferentOddAndEvenPagesAsync()

Gets or sets a value indicating whether the section has different odd and even page.

Declaration

public Task<bool> GetDifferentOddAndEvenPagesAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetEndnoteNumberFormatAsync()

Gets or sets the number format of endnote.

Declaration

public Task<FootEndNoteNumberFormat> GetEndnoteNumberFormatAsync()

Returns

Type	Description
System.Threading.Tasks.Task<FootEndNoteNumberFormat>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetEqualWidthColumnsAsync()

Gets or sets a value indicating whether all the columns on a page has even width and space. The default value is True.

Declaration

public Task<int> GetEqualWidthColumnsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>	Returns true, if all columns are evenly spaced. Otherwise false.

GetFooterDistanceAsync()

Gets or sets the footer distance.

Declaration

public Task<int> GetFooterDistanceAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetFooterDistanceDoubleAsync()

Gets or sets the footer distance.

Declaration

public Task<double> GetFooterDistanceDoubleAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetFootnoteNumberFormatAsync()

Gets or sets the number format of footnote.

Declaration

public Task<FootEndNoteNumberFormat> GetFootnoteNumberFormatAsync()

Returns

Type	Description
System.Threading.Tasks.Task<FootEndNoteNumberFormat>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetHeaderDistanceAsync()

Gets or sets the header distance.

Declaration

public Task<int> GetHeaderDistanceAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetHeaderDistanceDoubleAsync()

Gets or sets the header distance.

Declaration

public Task<double> GetHeaderDistanceDoubleAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetInitialEndnoteNumberAsync()

Gets or sets the number format of footnote.

Declaration

public Task<int> GetInitialEndnoteNumberAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetInitialFootnoteNumberAsync()

Gets or sets the number format of footnote.

Declaration

public Task<int> GetInitialFootnoteNumberAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetLeftMarginAsync()

Gets or sets the page left margin.

Declaration

public Task<int> GetLeftMarginAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetLeftMarginDoubleAsync()

Gets or sets the page left margin.

Declaration

public Task<double> GetLeftMarginDoubleAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetLineBetweenColumnsAsync()

Gets or sets a value indicating whether the vertical lines appear between all the columns. The default vaue is False.

Declaration

public Task<int> GetLineBetweenColumnsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>	Returns true if vertical lines appear between all the columns. Otherwise false.

GetNumberOfColumnsAsync()

Gets the number of columns on a page.

Declaration

public Task<int> GetNumberOfColumnsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>	Returns the number of columns on a page.

GetPageHeightAsync()

Gets or sets the page height.

Declaration

public Task<int> GetPageHeightAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetPageHeightDoubleAsync()

Gets or sets the page height.

Declaration

public Task<double> GetPageHeightDoubleAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetPageWidthAsync()

Gets or sets the page width.

Declaration

public Task<int> GetPageWidthAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetPageWidthDoubleAsync()

Gets or sets the page width.

Declaration

public Task<double> GetPageWidthDoubleAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetRightMarginAsync()

Gets or sets the page right margin.

Declaration

public Task<int> GetRightMarginAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetRightMarginDoubleAsync()

Gets or sets the page right margin.

Declaration

public Task<double> GetRightMarginDoubleAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetTopMarginAsync()

Gets or sets the page top margin.

Declaration

public Task<int> GetTopMarginAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>	A System.Threading.Tasks.Task representing the asynchronous operation.

GetTopMarginDoubleAsync()

Gets or sets the page top margin.

Declaration

public Task<double> GetTopMarginDoubleAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>	A System.Threading.Tasks.Task representing the asynchronous operation.

SetBottomMarginAsync(Int32)

Gets or sets the page bottom margin.

Declaration

public void SetBottomMarginAsync(int value)

Parameters

Type	Name	Description
System.Int32	value	Specifies the bottom margin.

SetBottomMarginDoubleAsync(Double)

Gets or sets the page bottom margin.

Declaration

public void SetBottomMarginDoubleAsync(double value)

Parameters

Type	Name	Description
System.Double	value	Specifies the bottom margin.

SetColumns(SelectionColumnFormat[])

Gets or sets the columns.

Declaration

public void SetColumns(SelectionColumnFormat[] value)

Parameters

Type	Name	Description
SelectionColumnFormat[]	value

SetDifferentFirstPageAsync(Boolean)

Gets or sets a value indicating whether the section has different first page.

Declaration

public void SetDifferentFirstPageAsync(bool value)

Parameters

Type	Name	Description
System.Boolean	value	Specifies the different first page.

SetDifferentOddAndEvenPagesAsync(Boolean)

Gets or sets a value indicating whether the section has different odd and even page.

Declaration

public void SetDifferentOddAndEvenPagesAsync(bool value)

Parameters

Type	Name	Description
System.Boolean	value	Specifies the different odd and even pages.

SetEndnoteNumberFormatAsync(FootEndNoteNumberFormat)

Gets or sets the number format of endnote.

Declaration

public void SetEndnoteNumberFormatAsync(FootEndNoteNumberFormat value)

Parameters

Type	Name	Description
FootEndNoteNumberFormat	value	Specifies the number format.

SetEqualWidthColumnsAsync(Boolean)

Gets or sets a value indicating whether all the columns on a page has even width and space. The default value is True.

Declaration

public void SetEqualWidthColumnsAsync(bool value)

Parameters

Type	Name	Description
System.Boolean	value

SetFooterDistanceAsync(Int32)

Gets or sets the footer distance.

Declaration

public void SetFooterDistanceAsync(int value)

Parameters

Type	Name	Description
System.Int32	value	Specifies the footer distance.

SetFooterDistanceDoubleAsync(Double)

Gets or sets the footer distance.

Declaration

public void SetFooterDistanceDoubleAsync(double value)

Parameters

Type	Name	Description
System.Double	value	Specifies the footer distance.

SetFootnoteNumberFormatAsync(FootEndNoteNumberFormat)

Gets or sets the number format of footnote.

Declaration

public void SetFootnoteNumberFormatAsync(FootEndNoteNumberFormat value)

Parameters

Type	Name	Description
FootEndNoteNumberFormat	value	Specifies the number format.

SetHeaderDistanceAsync(Int32)

Gets or sets the header distance.

Declaration

public void SetHeaderDistanceAsync(int value)

Parameters

Type	Name	Description
System.Int32	value	Specifies the header distance.

SetHeaderDistanceDoubleAsync(Double)

Gets or sets the header distance.

Declaration

public void SetHeaderDistanceDoubleAsync(double value)

Parameters

Type	Name	Description
System.Double	value	Specifies the header distance.

SetInitialEndnoteNumberAsync(Int32)

Gets or sets the number format of footnote.

Declaration

public void SetInitialEndnoteNumberAsync(int value)

Parameters

Type	Name	Description
System.Int32	value	Specifies the initial end note number.

SetInitialFootnoteNumberAsync(Int32)

Gets or sets the number format of footnote.

Declaration

public void SetInitialFootnoteNumberAsync(int value)

Parameters

Type	Name	Description
System.Int32	value	Specifies the initial foot note number.

SetLeftMarginAsync(Int32)

Gets or sets the page left margin.

Declaration

public void SetLeftMarginAsync(int value)

Parameters

Type	Name	Description
System.Int32	value	Specifies the left margin.

SetLeftMarginDoubleAsync(Double)

Gets or sets the page left margin.

Declaration

public void SetLeftMarginDoubleAsync(double value)

Parameters

Type	Name	Description
System.Double	value	Specifies the left margin.

SetLineBetweenColumnsAsync(Boolean)

Gets or sets a value indicating whether the vertical lines appear between all the columns. The default vaue is False.

Declaration

public void SetLineBetweenColumnsAsync(bool value)

Parameters

Type	Name	Description
System.Boolean	value

SetPageHeightAsync(Int32)

Gets or sets the page height.

Declaration

public void SetPageHeightAsync(int value)

Parameters

Type	Name	Description
System.Int32	value	Specifies the page height.

SetPageHeightDoubleAsync(Double)

Gets or sets the page height.

Declaration

public void SetPageHeightDoubleAsync(double value)

Parameters

Type	Name	Description
System.Double	value	Specifies the page height.

SetPageWidthAsync(Int32)

Gets or sets the page width.

Declaration

public void SetPageWidthAsync(int value)

Parameters

Type	Name	Description
System.Int32	value	Specifies the page width.

SetPageWidthDoubleAsync(Double)

Gets or sets the page width.

Declaration

public void SetPageWidthDoubleAsync(double value)

Parameters

Type	Name	Description
System.Double	value	Specifies the page width.

SetRightMarginAsync(Int32)

Gets or sets the page right margin.

Declaration

public void SetRightMarginAsync(int value)

Parameters

Type	Name	Description
System.Int32	value	Specifies the right margin.

SetRightMarginDoubleAsync(Double)

Gets or sets the page right margin.

Declaration

public void SetRightMarginDoubleAsync(double value)

Parameters

Type	Name	Description
System.Double	value	Specifies the right margin.

SetTopMarginAsync(Int32)

Gets or sets the page top margin.

Declaration

public void SetTopMarginAsync(int value)

Parameters

Type	Name	Description
System.Int32	value	Specifies the top margin.

SetTopMarginDoubleAsync(Double)

Gets or sets the page top margin.

Declaration

public void SetTopMarginDoubleAsync(double value)

Parameters

Type	Name	Description
System.Double	value	Specifies the top margin.