ActionUrl.TextFormatString Property

Specifies a caption which is used when an ActionUrl is displayed in a List View’s grid editor.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v23.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public string TextFormatString { get; set; }

VB.NET

Public Property TextFormatString As String

Property Value

Type	Description
String	A string that represents a caption.

Remarks

When an ActionUrl is related to an object selected in a List View, it can be displayed in an additional cell for each object in the List View’s grid editor:

In this instance, the Action’s ActionBase.Caption property value is displayed as the additional column’s header. The text displayed in the cells of this column is specified by the TextFormatString property.

You can insert a particular property of the current object in the TextFormatString property value. Specify this property via the ActionUrl.TextFieldName property and specify the TextFormatString property as shown below:

C#

public class DomainObject1 : BaseObject {
   //...
   private string name;
   public string Name {
      get { return name; }
      set { SetPropertyValue(ref name, value); }
   }
}
public partial class ViewController1 : ViewController{
   private void InitializeComponent(){
      //...
      this.urlAction1 = new DevExpress.ExpressApp.Actions.ActionUrl(this.components);
      this.urlAction1.TextFieldName = "Name";
      this.urlAction1.TextFormatString = "Go to {0}'s site";
      //...
   }
}

VB.NET

Public Class DomainObject1
      Inherits BaseObject
   '...
   Private fname As String
    Public Property Name As String
        Get
            Return name
        End Get
        Set(ByVal value As String)
            SetPropertyValue(fname, value)
        End Set
    End Property
End Class
Public Partial Class ViewController1
      Inherits ViewController
   Private Sub InitializeComponent()
      '...
      Me.urlAction1 = New DevExpress.ExpressApp.Actions.ActionUrl(Me.components)
      Me.urlAction1.TextFieldName = "Name"
      Me.urlAction1.TextFormatString = "Go to {0}'s site"
      '...
   End Sub
End Class

The following image demonstrates how the urlAction1 from the code above is displayed in the DomainObject1 List View:

To display an Action as an additional cell for each object in a List View, set its ActionBase.SelectionDependencyType property to SelectionDependencyType.RequireSingleObject and the ActionBase.Category property - to “RecordEdit”.