NuGet
State query service
Query current formatting, selection capabilities and document context. Use the result to reflect editor state in native application controls.
The facade is available as editor.StateQuery; its interface can be replaced by an application implementation.
Use it in your application
A query is a current observation, not a lock on the document. Recheck command capability when the action runs and coalesce frequent selection-driven refreshes.
All examples assume an editor named editor, already attached to a visible window, and an awaited editor.Ready. Keep operations asynchronous instead of blocking the UI thread.
commandButton.IsEnabled = await editor.StateQuery.CanUndoAsync();
bool bold = await editor.StateQuery.IsBoldAsync();Members
These signatures come from the delivered 1.0.2 assemblies and XML documentation. Cancellation tokens can be supplied to awaited operations. Follow the source-specific notes above when adapting a WPF integration.
| Member | Signature |
|---|---|
CanCopyAsync | Task<bool> CanCopyAsync(CancellationToken cancellationToken) |
CanCutAsync | Task<bool> CanCutAsync(CancellationToken cancellationToken) |
CanDeleteAsync | Task<bool> CanDeleteAsync(CancellationToken cancellationToken) |
CanMergeTableCellsAsync | Task<bool> CanMergeTableCellsAsync(CancellationToken cancellationToken) |
CanRedoAsync | Task<bool> CanRedoAsync(CancellationToken cancellationToken) |
CanUndoAsync | Task<bool> CanUndoAsync(CancellationToken cancellationToken) |
GetActiveFontFamilyNameAsync | Task<string> GetActiveFontFamilyNameAsync(CancellationToken cancellationToken) |
GetActiveFontSizeAsync | Task<string> GetActiveFontSizeAsync(CancellationToken cancellationToken) |
GetActiveForeColorAsync | Task<Color> GetActiveForeColorAsync(CancellationToken cancellationToken) |
GetActiveForeColorCssAsync | Task<string> GetActiveForeColorCssAsync(CancellationToken cancellationToken) |
GetActiveHighlightColorAsync | Task<Color> GetActiveHighlightColorAsync(CancellationToken cancellationToken) |
GetActiveHighlightColorCssAsync | Task<string> GetActiveHighlightColorCssAsync(CancellationToken cancellationToken) |
GetSnapshotAsync | Task<EditorSnapshot> GetSnapshotAsync(CancellationToken cancellationToken) |
IsBoldAsync | Task<bool> IsBoldAsync(CancellationToken cancellationToken) |
IsHyperLinkAsync | Task<bool> IsHyperLinkAsync(CancellationToken cancellationToken) |
IsImageAsync | Task<bool> IsImageAsync(CancellationToken cancellationToken) |
IsItalicAsync | Task<bool> IsItalicAsync(CancellationToken cancellationToken) |
IsJustifyCenterAsync | Task<bool> IsJustifyCenterAsync(CancellationToken cancellationToken) |
IsJustifyLeftAsync | Task<bool> IsJustifyLeftAsync(CancellationToken cancellationToken) |
IsJustifyRightAsync | Task<bool> IsJustifyRightAsync(CancellationToken cancellationToken) |
IsOrderedListAsync | Task<bool> IsOrderedListAsync(CancellationToken cancellationToken) |
IsStrikeThroughAsync | Task<bool> IsStrikeThroughAsync(CancellationToken cancellationToken) |
IsSubscriptAsync | Task<bool> IsSubscriptAsync(CancellationToken cancellationToken) |
IsSuperscriptAsync | Task<bool> IsSuperscriptAsync(CancellationToken cancellationToken) |
IsTableAsync | Task<bool> IsTableAsync(CancellationToken cancellationToken) |
IsTableCellAsync | Task<bool> IsTableCellAsync(CancellationToken cancellationToken) |
IsUnderlineAsync | Task<bool> IsUnderlineAsync(CancellationToken cancellationToken) |
IsUnorderedListAsync | Task<bool> IsUnorderedListAsync(CancellationToken cancellationToken) |
IsYouTubeVideoAsync | Task<bool> IsYouTubeVideoAsync(CancellationToken cancellationToken) |
QueryCommandStateAsync | Task<bool> QueryCommandStateAsync(string commandName, CancellationToken cancellationToken) |
QueryCommandValueAsync | Task<string> QueryCommandValueAsync(string commandName, CancellationToken cancellationToken) |