TextFrameAttributesDialog Method
- Namespace
TXTextControl.WPF
- Package
TXTextControl.asTextControl. WPF. SDK TXTextControl.from the private NuGet feed or Text Control Offline PackagesWPF. dll
Description
Invokes the built-in dialog box for setting attributes of text frames. This dialog box is only shown, if a text frame is currently selected. The TextFrameCollection.GetItem method can be used to test whether a text frame is selected or not.
Syntax
TextFrameAttributesDialog()
Opens the dialog box showing the last opened tab.
public DialogResult TextFrameAttributesDialog();Public Function TextFrameAttributesDialog() As DialogResultTextFrameAttributesDialog(int)
Opens the dialog box showing the specified tab.
public DialogResult TextFrameAttributesDialog(int activeTab);Public Function TextFrameAttributesDialog(activeTab As Integer) As DialogResult| Parameter | Description |
|---|---|
| activeTab | Specifies the index of the tab, zero-based, that is displayed when the tabbed dialog box is opened. If this parameter is 0, the dialog box shows the tab for setting text wrapping and layout attributes, if this parameter is 1, the dialog box shows the tab for setting size and distances and if it is 2, the dialog shows the tab for setting further textframe attributes such as a frame line or a background color. |
Return Value
If the dialog has been left with the Cancel button the return value is DialogResult.Cancel. Otherwise, it is DialogResult.OK.
Examples
The following example opens the text frame attributes dialog for the text control.
var result = textControl.TextFrameAttributesDialog(10);
Console.WriteLine($"Text Frame Attributes Dialog result: {result}");Dim result = textControl.TextFrameAttributesDialog(10)
Console.WriteLine($"Text Frame Attributes Dialog result: {result}")