Table of Contents

Class BindingInfoTemplate

Namespace
CMS.DataEngine.Generators
Assembly
CMS.DataEngine.dll

Class to produce the template output

[Obsolete("The code generation API is not intended to be used directly. Use the code generator command line-based tool instead.")]
[ObsoleteSince(28, 0)]
public class BindingInfoTemplate : BindingInfoTemplateBase
Inheritance
object
BindingInfoTemplate
Inherited Members
Extension Methods

Constructors

BindingInfoTemplate(DataClassInfo)

Initializes a new instance of the BindingInfoTemplate class using the specified data class.

public BindingInfoTemplate(DataClassInfo dataClass)

Parameters

dataClass DataClassInfo

Data class to initialize the template from.

Exceptions

ArgumentNullException

Thrown when dataClass is null.

BindingInfoTemplate(DataClassInfo, bool, string)

Initializes a new instance of the BindingInfoTemplate class using the specified data class.

public BindingInfoTemplate(DataClassInfo dataClass, bool withProviderClass, string customNamespace = null)

Parameters

dataClass DataClassInfo

Data class to initialize the template from.

withProviderClass bool

Indicates whether the info object has an explicit provider class generated.

customNamespace string

Custom namespace where class will be generated.

Exceptions

ArgumentNullException

Thrown when dataClass is null.

Properties

HasIdColumn

Indicates whether the ID column is defined.

public bool HasIdColumn { get; }

Property Value

bool

HasReferences

Determines whether there is at least one field which has a reference set to some object type.

public bool HasReferences { get; }

Property Value

bool

IdColumn

Gets the name of the ID column.

public string IdColumn { get; }

Property Value

string

InfoClassName

Gets the info class name.

public string InfoClassName { get; }

Property Value

string

InfoProviderClassName

Gets the info provider class name.

public string InfoProviderClassName { get; }

Property Value

string

InfoProviderInterfaceName

Gets the info provider interface name.

public string InfoProviderInterfaceName { get; }

Property Value

string

Namespace

Gets the namespace.

public string Namespace { get; }

Property Value

string

ObjectClassName

Gets the object class name.

public string ObjectClassName { get; }

Property Value

string

ObjectType

Gets the object type.

public string ObjectType { get; }

Property Value

string

ParentColumn

Gets the name of the parent column.

public string ParentColumn { get; }

Property Value

string

ParentObjectType

Gets the parent object type.

public string ParentObjectType { get; }

Property Value

string

Properties

Gets the info properties description.

public IEnumerable<BindingInfoTemplate.InfoTemplateProperty> Properties { get; }

Property Value

IEnumerable<BindingInfoTemplate.InfoTemplateProperty>

References

Gets the info properties description.

public IEnumerable<BindingInfoTemplate.InfoTemplateProperty> References { get; }

Property Value

IEnumerable<BindingInfoTemplate.InfoTemplateProperty>

Methods

GetCode(string, bool, string)

Returns generated code for binding class info.

public static string GetCode(string className, bool withProviderClass, string customNamespace = null)

Parameters

className string
withProviderClass bool
customNamespace string

Returns

string

TransformText()

Create the template output

public virtual string TransformText()

Returns

string