TX Text Control .NET for Windows Forms

ChartLayoutDialog Method

Method|Introduced in 18.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.WinForms.SDK as TXTextControl.Windows.Forms.dll from the private NuGet feed or Text Control Offline Packages

Description

Invokes the built-in dialog box for alter the layout settings, the size and the text distances of a chart. This dialog can only be invoked, if a chart has been selected.

Syntax

ChartLayoutDialog()

Opens the dialog box showing the last opened tab.

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

ChartLayoutDialog(int)

Opens the dialog box showing the specified tab.

public System.Windows.Forms.DialogResult ChartLayoutDialog(int activeTab);
ParameterDescription
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.

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 chart layout dialog for the text control.

var result = textControl.ChartLayoutDialog(10);
Console.WriteLine($"Chart Layout Dialog result: {result}");