Table of Contents

Class InfoTemplate

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 InfoTemplate : InfoTemplateBase
Inheritance
object
InfoTemplate
Inherited Members
Extension Methods

Constructors

InfoTemplate(DataClassInfo)

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

public InfoTemplate(DataClassInfo dataClass)

Parameters

dataClass DataClassInfo

Data class to initialize the template from.

Exceptions

ArgumentNullException

Thrown when dataClass is null.

InfoTemplate(DataClassInfo, bool, string)

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

public InfoTemplate(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

BinaryColumn

Gets the name of the binary column.

public string BinaryColumn { get; }

Property Value

string

CodeNameColumn

Gets the name of the code name column.

public string CodeNameColumn { get; }

Property Value

string

DisplayNameColumn

Gets the name of the display name column.

public string DisplayNameColumn { get; }

Property Value

string

GuidColumn

Gets the name of the GUID column.

public string GuidColumn { get; }

Property Value

string

HasCodeNameColumn

Indicates whether the codename column is defined.

public bool HasCodeNameColumn { get; }

Property Value

bool

HasGuidColumn

Indicates whether the GUID column is defined.

public bool HasGuidColumn { 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

InfoCacheByConfiguration

Gets the value representing the CacheBy configuration.

public string InfoCacheByConfiguration { 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

LastModifiedColumn

Gets the name of the "last modified" column.

public string LastModifiedColumn { get; }

Property Value

string

Namespace

Gets the namespace.

public string Namespace { get; set; }

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

Properties

Gets the info properties description.

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

Property Value

IEnumerable<InfoTemplate.InfoTemplateProperty>

Methods

GetCode(string, bool, string)

Returns generated code for 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