Class SelectionTableFormatModule
Represents the selection table format module in DocumentEditor.
Inheritance
Namespace: Syncfusion.Blazor.DocumentEditor
Assembly: Syncfusion.Blazor.DocumentEditor.dll
Syntax
public class SelectionTableFormatModule : ObjectConstructors
SelectionTableFormatModule(SfDocumentEditor)
Initializes a new instance of the SelectionTableFormatModule class. Default constructor for SelectionTableFormatModule.
Declaration
public SelectionTableFormatModule(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 |
Methods
GetBackgroundAsync()
Gets or Sets the background for selected table.
Declaration
public Task<string> GetBackgroundAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.String> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetBidiAsync()
Gets or sets the bidi property.
Declaration
public Task<bool> GetBidiAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetBottomMarginAsync()
Gets or Sets the default bottom margin of cell for selected table.
Declaration
public Task<int> GetBottomMarginAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Int32> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetCellSpacingAsync()
Gets or Sets the cell spacing for selected table.
Declaration
public Task<int> GetCellSpacingAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Int32> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetDescriptionAsync()
Gets the description of the selected table.
Declaration
public Task<string> GetDescriptionAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.String> | A System.Threading.Tasks.Task representing the asynchronous operation, that returns the description of the selected table. |
Remarks
This method allows you to get description for the currently selected table within a Blazor Document Editor component.
Examples
The following code example demonstrates how to get the description of the selected table in Blazor Document editor component.
string altText = await sfDocumentEditorContainer.DocumentEditor.Selection.TableFormat.GetDescriptionAsync();GetLeftIndentAsync()
Gets or Sets the left indent for selected table.
Declaration
public Task<int> GetLeftIndentAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Int32> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetLeftMarginAsync()
Gets or Sets the default left margin of cell for selected table.
Declaration
public Task<int> GetLeftMarginAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Int32> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetPreferredWidthAsync()
Gets or Sets the preferred width for selected table.
Declaration
public Task<int> GetPreferredWidthAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Int32> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetPreferredWidthTypeAsync()
Gets or Sets the preferred width type for selected table.
Declaration
public Task<WidthType> GetPreferredWidthTypeAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<WidthType> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetRightMarginAsync()
Gets or Sets the default right margin of cell for selected table.
Declaration
public Task<int> GetRightMarginAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Int32> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetTableAlignmentAsync()
Gets or Sets the table alignment for selected table.
Declaration
public Task<TableAlignment> GetTableAlignmentAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<TableAlignment> | A System.Threading.Tasks.Task representing the asynchronous operation. |
GetTitleAsync()
Gets the title of the selected table.
Declaration
public Task<string> GetTitleAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.String> | A System.Threading.Tasks.Task representing the asynchronous operation, that returns the title of the selected table. |
Remarks
This method allows you to get a title for the currently selected table within a Blazor Document Editor component.
Examples
The following code example demonstrates how to get the title of the selected table in Blazor Document editor component.
string altText = await sfDocumentEditorContainer.DocumentEditor.Selection.TableFormat.GetTitleAsync();GetTopMarginAsync()
Gets or Sets the default top margin of cell for selected table.
Declaration
public Task<int> GetTopMarginAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Int32> | A System.Threading.Tasks.Task representing the asynchronous operation. |
SetBackgroundAsync(String)
Gets or Sets the background for selected table.
Declaration
public void SetBackgroundAsync(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value | Specifies the background color. |
SetBidiAsync(Boolean)
Gets or sets the bidi property.
Declaration
public void SetBidiAsync(bool value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | value | Specifies the bidi. |
SetBottomMarginAsync(Int32)
Gets or Sets the default bottom margin of cell for selected table.
Declaration
public void SetBottomMarginAsync(int value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | value | Specifies the bottom margin. |
SetCellSpacingAsync(Int32)
Gets or Sets the cell spacing for selected table.
Declaration
public void SetCellSpacingAsync(int value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | value | Specifies the cell spacing. |
SetDescriptionAsync(String)
Sets the description of the selected table.
Declaration
public Task SetDescriptionAsync(string description)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | description | The description of the selected table. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
Remarks
This method allows you to set a description for the currently selected table within a Blazor Document Editor component.
Examples
The following code example demonstrates how to set the description for the selected table in Blazor Document editor component.
await sfDocumentEditorContainer.DocumentEditor.Selection.TableFormat.SetDescriptionAsync("The giant panda is a bear species endemic to China.");SetLeftIndentAsync(Int32)
Gets or Sets the left indent for selected table.
Declaration
public void SetLeftIndentAsync(int value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | value | Specifies the left indent. |
SetLeftMarginAsync(Int32)
Gets or Sets the default left margin of cell for selected table.
Declaration
public void SetLeftMarginAsync(int value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | value | Specifies the left margin. |
SetPreferredWidthAsync(Int32)
Gets or Sets the preferred width for selected table.
Declaration
public void SetPreferredWidthAsync(int value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | value | Specifies the preferred width. |
SetPreferredWidthTypeAsync(WidthType)
Gets or Sets the preferred width type for selected table.
Declaration
public void SetPreferredWidthTypeAsync(WidthType value)Parameters
| Type | Name | Description |
|---|---|---|
| WidthType | value | Specifies the preferred width type. |
SetRightMarginAsync(Int32)
Gets or Sets the default right margin of cell for selected table.
Declaration
public void SetRightMarginAsync(int value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | value | Specifies the right margin. |
SetTableAlignmentAsync(TableAlignment)
Gets or Sets the table alignment for selected table.
Declaration
public void SetTableAlignmentAsync(TableAlignment value)Parameters
| Type | Name | Description |
|---|---|---|
| TableAlignment | value | Specifies the table alignment. |
SetTitleAsync(String)
Sets the title of the selected table.
Declaration
public Task SetTitleAsync(string title)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | title | The title of the selected table. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing the asynchronous operation. |
Remarks
This method allows you to set title for the currently selected table within a Blazor Document Editor component.
Examples
The following code example demonstrates how to set the title for the selected table in Blazor Document editor component.
await sfDocumentEditorContainer.DocumentEditor.Selection.TableFormat.SetTitleAsync("Gaint Panda");SetTopMarginAsync(Int32)
Gets or Sets the default top margin of cell for selected table.
Declaration
public void SetTopMarginAsync(int value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | value | Specifies the top margin. |