This is the most recent version of Tekla Open API.
For older versions, please visit Tekla Warehouse.

OperationProgressBarDisplay Method

Display progress bar dialog with cancel button. Display will fail if progress bar is already displayed.

Namespace: Tekla.Structures.Model.Operations
Assembly: Tekla.Structures.Model (in Tekla.Structures.Model.dll) Version: 2023.0.1

Syntax

Copy

public bool Display(
	int SleepTime,
	string Title,
	string Message,
	string CancelButtonLabel,
	string ProgressLabel
)

Public Function Display ( 
	SleepTime As Integer,
	Title As String,
	Message As String,
	CancelButtonLabel As String,
	ProgressLabel As String
) As Boolean

Parameters

SleepTime: Type: SystemInt32
Time (ms) to wait until bar is displayed.
Title: Type: SystemString
Title of the dialog.
Message: Type: SystemString
Message to be displayed on the dialog above progress bar.
CancelButtonLabel: Type: SystemString
Label of cancel button.
ProgressLabel: Type: SystemString
Initial progress label (updated with SetProgress). If empty of null no bar exists.

Return Value

Type: Boolean
True if bar was displayed successfully (meaning bar must be closed later).

Reference

OperationProgressBar Class

Tekla.Structures.Model.Operations Namespace

API Reference

OperationAddLanguageSpecificTextSet("LSTB75E59A0_0?cpp=::|nu=.");ProgressBarAddLanguageSpecificTextSet("LSTB75E59A0_1?cpp=::|nu=.");Display Method

Parameters

Return Value

Reference

OperationProgressBarDisplay Method