HyperLinkProperties.TextFormatString Property

Gets or sets the pattern used to format the hyperlinks’s caption text within the inplace hyperlink editor.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

[DefaultValue("{0}")]
public string TextFormatString { get; set; }

VB.NET

<DefaultValue("{0}")>
Public Property TextFormatString As String

Property Value

Type	Default	Description
String	"{0}"	A string value that represents the format pattern.

Remarks

Use the TextFormatString property to provide a custom format, used to display the hyperlink editor’s caption text. The text is specified via the HyperLinkProperties.Text or HyperLinkProperties.TextField property.

Note

Display values can be formatted using the standard formatting mechanism. It allows you to format values using standard format patterns. Format specifiers for composing the format pattern are described in the Numeric Format Strings and Date and Time Format Strings topics.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the TextFormatString property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

asp-net-web-forms-grid-create-hyperlink-column-at-runtime/CS/Default.aspx.cs#L43

colItemName.PropertiesHyperLinkEdit.NavigateUrlFormatString = "~/details.aspx?Device={0}";
colItemName.PropertiesHyperLinkEdit.TextFormatString = "Get details about device {0}";
colItemName.PropertiesHyperLinkEdit.TextField = "ItemName";

VB.NET

asp-net-web-forms-grid-create-hyperlink-column-at-runtime/VB/Default.aspx.vb#L45

colItemName.PropertiesHyperLinkEdit.NavigateUrlFormatString = "~/details.aspx?Device={0}"
colItemName.PropertiesHyperLinkEdit.TextFormatString = "Get details about device {0}"
colItemName.PropertiesHyperLinkEdit.TextField = "ItemName"