Class SelectionModule
Represents the selection module in DocumentEditor.
Inheritance
Namespace: Syncfusion.Blazor.DocumentEditor
Assembly: Syncfusion.Blazor.DocumentEditor.dll
Syntax
public class SelectionModule : ObjectConstructors
SelectionModule(SfDocumentEditor)
Initializes a new instance of the SelectionModule class. Default constructor for Selection.
Declaration
public SelectionModule(SfDocumentEditor baseComponent)Parameters
| Type | Name | Description |
|---|---|---|
| SfDocumentEditor | baseComponent | An DocumentEdiorComponent instance. |
Properties
CellFormat
Gets the current instance of selection cell format.
Declaration
public SelectionCellFormatModule CellFormat { get; }Property Value
| Type | Description |
|---|---|
| SelectionCellFormatModule | Returns SelectionCellFormatModule, refer SelectionCellFormatModule . |
CharacterFormat
Gets the current instance of selection character format.
Declaration
public SelectionCharacterFormatModule CharacterFormat { get; }Property Value
| Type | Description |
|---|---|
| SelectionCharacterFormatModule | Returns SelectionCharacterFormatModule, refer SelectionCharacterFormatModule. |
DocumentEditor
DocumentEdiorComponent instance.
Declaration
protected SfDocumentEditor DocumentEditor { get; set; }Property Value
| Type | Description |
|---|---|
| SfDocumentEditor |
ImageFormat
Gets the instance of selection image format.
Declaration
public SelectionImageFormatModule ImageFormat { get; }Property Value
| Type | Description |
|---|---|
| SelectionImageFormatModule | Returns SelectionImageFormatModule, refer SelectionImageFormatModule. |
ParagraphFormat
Gets the instance of selection paragraph format.
Declaration
public SelectionParagraphFormatModule ParagraphFormat { get; }Property Value
| Type | Description |
|---|---|
| SelectionParagraphFormatModule | Returns SelectionParagraphFormatModule, refer SelectionParagraphFormatModule. |
RowFormat
Gets the instance of selection row format.
Declaration
public SelectionRowFormatModule RowFormat { get; }Property Value
| Type | Description |
|---|---|
| SelectionRowFormatModule |
SectionFormat
Gets the instance of selection section format.
Declaration
public SelectionSectionFormatModule SectionFormat { get; }Property Value
| Type | Description |
|---|---|
| SelectionSectionFormatModule | Returns SelectionSectionFormatModule, refer SelectionSectionFormatModule. |
TableFormat
Gets the instance of selection table format.
Declaration
public SelectionTableFormatModule TableFormat { get; }Property Value
| Type | Description |
|---|---|
| SelectionTableFormatModule | Returns SelectionTableFormatModule, refer SelectionTableFormatModule. |
Methods
GetCellFormat()
Gets the current instance of selection cell format.
Declaration
public SelectionCellFormatModule GetCellFormat()Returns
| Type | Description |
|---|---|
| SelectionCellFormatModule | Returns SelectionCellFormatModule, refer SelectionCellFormatModule . |
GetCharacterFormat()
Gets the current instance of selection character format.
Declaration
public SelectionCharacterFormatModule GetCharacterFormat()Returns
| Type | Description |
|---|---|
| SelectionCharacterFormatModule | Returns SelectionCharacterFormatModule, refer SelectionCharacterFormatModule. |
GetImageFormat()
Gets the instance of selection image format.
Declaration
public SelectionImageFormatModule GetImageFormat()Returns
| Type | Description |
|---|---|
| SelectionImageFormatModule | Returns SelectionImageFormatModule, refer SelectionImageFormatModule. |
GetParagraphFormat()
Gets the instance of selection paragraph format.
Declaration
public SelectionParagraphFormatModule GetParagraphFormat()Returns
| Type | Description |
|---|---|
| SelectionParagraphFormatModule | Returns SelectionParagraphFormatModule, refer SelectionParagraphFormatModule. |
GetRowFormat()
Gets the instance of selection row format.
Declaration
public SelectionRowFormatModule GetRowFormat()Returns
| Type | Description |
|---|---|
| SelectionRowFormatModule | Returns SelectionRowFormatModule, refer SelectionRowFormatModule. |
GetSectionFormat()
Gets the instance of selection section format.
Declaration
public SelectionSectionFormatModule GetSectionFormat()Returns
| Type | Description |
|---|---|
| SelectionSectionFormatModule | Returns SelectionSectionFormatModule, refer SelectionSectionFormatModule. |
GetSfdtAsync()
Gets the selected content of the document as SFDT (Syncfusion Document Text) file format.
Declaration
public Task<string> GetSfdtAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.String> | Returns an asynchronous operation of string type that represents the SFDT (Syncfusion Document Text) file format. If no content is selected, then it returns null. |
Examples
The following code example demonstrates how to retrieve the selected content of the document as SFDT and paste the same in the document editor.
// Gets the selected content of the document as SFDT and paste the same in the document editor.
SfDocumentEditorContainer container;
await string sfdt = container.DocumentEditor.Selection.GetSfdtAsync();
await container.DocumentEditor.Editor.PasteAsync(sfdt);GetTableFormat()
Gets the instance of selection table format.
Declaration
public SelectionTableFormatModule GetTableFormat()Returns
| Type | Description |
|---|---|
| SelectionTableFormatModule | Returns SelectionTableFormatModule, refer SelectionTableFormatModule. |
IsSelectionInsideFieldAsync()
Returns true if selection is in field.
Declaration
public Task<bool> IsSelectionInsideFieldAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> | Returns an asynchronous operation. |