Description

Invokes the built-in dialog box for setting formatting attributes of tables. The TableCollection.GetItem method can be used to test whether a table is selected or not.

Syntax

TableFormatDialog()

Opens the dialog box showing the last opened tab.

public System.Windows.Forms.DialogResult TableFormatDialog();

Public Function TableFormatDialog() As System.Windows.Forms.DialogResult

TableFormatDialog(int)

Opens the dialog box showing the specified tab.

public System.Windows.Forms.DialogResult TableFormatDialog(int activeTab);

Public Function TableFormatDialog(activeTab As Integer) As System.Windows.Forms.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 frame lines, color and distances, and if this parameter is 1, the dialog box shows the tab for setting vertical size and alignment and if this parameter is 2, the dialog box shows the tab for setting formulas and numberformats.

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 table format dialog for the text control.

var result = textControl.TableFormatDialog(10);
Console.WriteLine($"Table Format Dialog result: {result}");

Dim result = textControl.TableFormatDialog(10)
Console.WriteLine($"Table Format Dialog result: {result}")