FieldTemplateFactory.BuildVirtualPath Method

Definition

Namespace:

System.Web.DynamicData

Assembly:

System.Web.DynamicData.dll

Builds the virtual path to a field template based on the field template name and the mode.

public:
 virtual System::String ^ BuildVirtualPath(System::String ^ templateName, System::Web::DynamicData::MetaColumn ^ column, System::Web::UI::WebControls::DataBoundControlMode mode);

public virtual string BuildVirtualPath (string templateName, System.Web.DynamicData.MetaColumn column, System.Web.UI.WebControls.DataBoundControlMode mode);

abstract member BuildVirtualPath : string * System.Web.DynamicData.MetaColumn * System.Web.UI.WebControls.DataBoundControlMode -> string
override this.BuildVirtualPath : string * System.Web.DynamicData.MetaColumn * System.Web.UI.WebControls.DataBoundControlMode -> string

Public Overridable Function BuildVirtualPath (templateName As String, column As MetaColumn, mode As DataBoundControlMode) As String

Parameters

templateName

String

The name of the template to use.

column

MetaColumn

Specifies the data column which the field template applies to.

mode

DataBoundControlMode

Specifies the display mode of the field template.

Returns

String

The virtual path to the field template.

Exceptions

ArgumentNullException

templateName is null.

Remarks

By default, this method builds the virtual path to a field template by using the template name, appending the mode and then adding a .ascx extension. For example, if templateName is MyFieldTemplate and mode is Edit, then the virtual path will be MyFieldTemplate_Edit.ascx, in the folder specified by the Template folder virtual path.