Class SelectionModule
Represents the selection module in DocumentEditor.
Inheritance
Namespace: Syncfusion.Blazor.DocumentEditor
Assembly: Syncfusion.Blazor.dll
Syntax
public class SelectionModule : Object
Constructors
SelectionModule(BaseComponent)
Default constructor for Selection.
Declaration
public SelectionModule(BaseComponent baseComponent)
Parameters
Type | Name | Description |
---|---|---|
BaseComponent | baseComponent | An DocumentEdiorComponent instance. |
Properties
DocumentEditorComponent
DocumentEdiorComponent instance.
Declaration
protected BaseComponent DocumentEditorComponent { get; set; }
Property Value
Type | Description |
---|---|
BaseComponent |
Methods
CheckSelectionIsAtEditRegion()
Check if selection is in edit region.
Declaration
public Task<bool> CheckSelectionIsAtEditRegion()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Boolean> | Returns an asynchronous operation. |
CloseHeaderFooter()
Closes the header and footer region.
Declaration
public Task CloseHeaderFooter()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
Copy()
Copies the selected content to clipboard.
Declaration
public Task Copy()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
CopyHyperlink()
Copies the hyperlink URL if the context is within hyperlink.
Declaration
public Task CopyHyperlink()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
ExtendBackward()
Extends selection backward.
Declaration
public Task ExtendBackward()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
ExtendForward()
Extends selection forward.
Declaration
public Task ExtendForward()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
ExtendToLineEnd()
Extend selection from current position to end of line.
Declaration
public Task ExtendToLineEnd()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
ExtendToLineStart()
Extend selection from current position to start of line.
Declaration
public Task ExtendToLineStart()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
ExtendToNextLine()
Extend selection from current position to next line.
Declaration
public Task ExtendToNextLine()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
ExtendToParagraphEnd()
Extend selection from selection from current position to paragraph end.
Declaration
public Task ExtendToParagraphEnd()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
ExtendToParagraphStart()
Extends selection from current position to paragraph start.
Declaration
public Task ExtendToParagraphStart()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
ExtendToPreviousLine()
Extends selection from current position to previous line.
Declaration
public Task ExtendToPreviousLine()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
ExtendToWordEnd()
Extends selection to word end.
Declaration
public Task ExtendToWordEnd()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
ExtendToWordStart()
Extends selection to word start.
Declaration
public Task ExtendToWordStart()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
GetBookmarks()
Gets bookmark name collection.
Declaration
public Task<List<string>> GetBookmarks()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<System.String>> | Returns an asynchronous operation. |
GetBookmarks(Nullable<Boolean>)
Gets the bookmark name collection in current selection.
Declaration
public Task<List<string>> GetBookmarks(Nullable<bool> includeHidden = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Boolean> | includeHidden | Include hidden bookmarks. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<System.String>> | Returns an asynchronous operation of list of string. |
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. |
GetContextType()
Gets the context type of the selection.
Declaration
public Task<ContextType> GetContextType()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ContextType> | Returns an asynchronous operation of ContextType, refer ContextType |
GetEndPage()
Gets the page number where the selection ends.
Declaration
public Task<int> GetEndPage()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Int32> |
GetImageFormat()
Gets the instance of selection image format.
Declaration
public SelectionImageFormatModule GetImageFormat()
Returns
Type | Description |
---|---|
SelectionImageFormatModule | Returns SelectionImageFormatModule, refer SelectionImageFormatModule. |
GetIsInField()
Returns true if selection is in field
Declaration
public Task<bool> GetIsInField()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Boolean> |
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 |
GetSectionFormat()
Gets the instance of selection section format.
Declaration
public SelectionSectionFormatModule GetSectionFormat()
Returns
Type | Description |
---|---|
SelectionSectionFormatModule | Returns SelectionSectionFormatModule, refer SelectionSectionFormatModule. |
GetStartPage()
Gets the page number where the selection ends.
Declaration
public Task<int> GetStartPage()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Int32> |
GetTableFormat()
Gets the instance of selection table format.
Declaration
public SelectionTableFormatModule GetTableFormat()
Returns
Type | Description |
---|---|
SelectionTableFormatModule | Returns SelectionTableFormatModule, refer SelectionTableFormatModule. |
GetText()
Gets the text within selection.
Declaration
public Task<string> GetText()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.String> | Returns an asynchronous operation of string type. |
GoToFooter()
Moves the selection to the footer of current page.
Declaration
public Task GoToFooter()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
GoToHeader()
Moves the selection to the header of current page.
Declaration
public Task GoToHeader()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
GoToPage(Double)
Moves the selection to the start of specified page number.
Declaration
public Task GoToPage(double pageNumber)
Parameters
Type | Name | Description |
---|---|---|
System.Double | pageNumber | Page number to move. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
MoveToDocumentEnd()
Moves selection to end of the document.
Declaration
public Task MoveToDocumentEnd()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
MoveToDocumentStart()
Moves selection to start of the document.
Declaration
public Task MoveToDocumentStart()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
MoveToLineEnd()
Moves selection to end of the current line.
Declaration
public Task MoveToLineEnd()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
MoveToLineStart()
Moves selection to start of the current line.
Declaration
public Task MoveToLineStart()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
MoveToNextCharacter()
Moves selection to next character.
Declaration
public Task MoveToNextCharacter()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
MoveToNextLine()
Moves selection to next line.
Declaration
public Task MoveToNextLine()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
MoveToParagraphEnd()
Moves selection to current paragraph end.
Declaration
public Task MoveToParagraphEnd()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
MoveToParagraphStart()
Moves selection to current paragraph start.
Declaration
public Task MoveToParagraphStart()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
MoveToPreviousCharacter()
Moves selection to previous character.
Declaration
public Task MoveToPreviousCharacter()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
MoveToPreviousLine()
Moves selection to previous line.
Declaration
public Task MoveToPreviousLine()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
NavigateHyperlink()
Fires the RequestNavigateEventArgs event if current selection context is in hyperlink.
Declaration
public Task NavigateHyperlink()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
NavigateNextComment()
Navigate to next comment in the document.
Declaration
public Task NavigateNextComment()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
NavigateNextRevision()
Navigate to next revision in the document.
Declaration
public Task NavigateNextRevision()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
NavigatePreviousComment()
Navigate to previous comment in the document.
Declaration
public Task NavigatePreviousComment()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
NavigatePreviousRevision()
Navigate to previous revision in the document.
Declaration
public Task NavigatePreviousRevision()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
NavigateToNextEditingRegion()
Navigate to next editing region, where current user can edit.
Declaration
public Task NavigateToNextEditingRegion()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
NextEndnote()
Navigate to next Endnote from current selection.
Declaration
public Task NextEndnote()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
NextFootnote()
Navigate to next footnote from current selection.
Declaration
public Task NextFootnote()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
PreviousEndnote()
Navigate to previous Endnote from current selection.
Declaration
public Task PreviousEndnote()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
PreviousFootnote()
Navigate to previous footnote from current selection.
Declaration
public Task PreviousFootnote()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
Select(SelectionSettings)
Selects content based on selection settings
Declaration
public Task Select(SelectionSettings selectionSettings)
Parameters
Type | Name | Description |
---|---|---|
SelectionSettings | selectionSettings | Selection settings refer SelectionSettings. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
SelectAll()
Selects the entire document.
Declaration
public Task SelectAll()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
SelectBookmark(String)
Selects the specified bookmark.
Declaration
public Task SelectBookmark(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Bookmark name to select. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
SelectByHierarchicalIndex(String, String)
Selects based on start and end hierarchical index.
Declaration
public Task SelectByHierarchicalIndex(string start, string end)
Parameters
Type | Name | Description |
---|---|---|
System.String | start | Start index. |
System.String | end | End index. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
SelectCell()
Selects the entire cell if the context is within table.
Declaration
public Task SelectCell()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
SelectColumn()
Selects the entire column if the context is within table.
Declaration
public Task SelectColumn()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
SelectCurrentWord(Nullable<Boolean>)
Selects Current word.
Declaration
public Task SelectCurrentWord(Nullable<bool> excludeSpace = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.Boolean> | excludeSpace | Exclude space while selecting. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
SelectField()
Select the current field if selection is in field.
Declaration
public Task SelectField()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
SelectLine()
Selects current line.
Declaration
public Task SelectLine()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
SelectParagraph()
Selects current paragraph.
Declaration
public Task SelectParagraph()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
SelectRow()
Selects the entire row if the context is within table.
Declaration
public Task SelectRow()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
SelectTable()
Selects the entire table if the context is within table.
Declaration
public Task SelectTable()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
ShowAllEditingRegion()
Shows all the editing region, where current user can edit.
Declaration
public Task ShowAllEditingRegion()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |
ToggleEditingRegionHighlight()
Highlight all the editing region, where current user can edit.
Declaration
public Task ToggleEditingRegionHighlight()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Returns an asynchronous operation. |