Skip to main content

ASPxClientProgressBar.SetCustomDisplayFormat(text) Method

Sets the pattern used to format the displayed text for the progress bar.

Declaration

SetCustomDisplayFormat(
    text: string
): void

Parameters

Name Type Description
text string

A value that is the format pattern.

Remarks

When the ASPxProgressBar.DisplayMode property is set to ProgressBarDisplayMode.Custom, the text, which is displayed in progress bar, can be formatted using a format pattern. The pattern can be specified via the ASPxProgressBar.CustomDisplayFormat property on the server side, and using the SetCustomDisplayFormat method on the client side.

Within the pattern you can use the following arguments:

  • {0} - the current progress bar position;
  • {1} - the minimum progress bar value;
  • {2} - the maximum progress bar value.
See Also