Table of Contents

Class AlternativeFormInfoProvider

Namespace
CMS.FormEngine
Assembly
CMS.FormEngine.dll

Class providing AlternativeFormInfo management.

public class AlternativeFormInfoProvider : AbstractInfoProvider<AlternativeFormInfo, AlternativeFormInfoProvider>, IInfoProvider, ICustomizableProvider, IBulkOperationProvider, IWebFarmProvider, IInfoValidator<AlternativeFormInfo>, IInfoProvider<AlternativeFormInfo>, IInfoByIdProvider<AlternativeFormInfo>, IInfoByGuidProvider<AlternativeFormInfo>, IInfoByNameProvider<AlternativeFormInfo>, IBulkInfoProvider<AlternativeFormInfo>, IFullNameInfoProvider
Inheritance
object
AlternativeFormInfoProvider
Implements
Inherited Members
Extension Methods

Constructors

AlternativeFormInfoProvider()

Constructor.

public AlternativeFormInfoProvider()

Methods

DeleteAlternativeFormInfo(AlternativeFormInfo)

Deletes specified alternativeForm.

public static void DeleteAlternativeFormInfo(AlternativeFormInfo infoObj)

Parameters

infoObj AlternativeFormInfo

AlternativeForm object

DeleteAlternativeFormInfo(int)

Deletes specified alternativeForm.

public static void DeleteAlternativeFormInfo(int alternativeFormId)

Parameters

alternativeFormId int

AlternativeForm id

GetAlternativeFormInfo(int)

Returns the AlternativeFormInfo structure for the specified alternativeForm.

public static AlternativeFormInfo GetAlternativeFormInfo(int alternativeFormId)

Parameters

alternativeFormId int

AlternativeForm id

Returns

AlternativeFormInfo

GetAlternativeFormInfo(string)

Returns the AlternativeFormInfo structure for the alternative form specified by its full name.

public static AlternativeFormInfo GetAlternativeFormInfo(string alternativeFormFullName)

Parameters

alternativeFormFullName string

Full name of the alternative form ('classname.'formname')

Returns

AlternativeFormInfo

GetAlternativeFormInfoInternal(string)

Returns the AlternativeFormInfo structure for the alternative form specified by its full name.

protected AlternativeFormInfo GetAlternativeFormInfoInternal(string alternativeFormFullName)

Parameters

alternativeFormFullName string

Full name of the alternative form ('classname.'formname')

Returns

AlternativeFormInfo

GetAlternativeForms()

Returns the query for all alternative forms.

public static ObjectQuery<AlternativeFormInfo> GetAlternativeForms()

Returns

ObjectQuery<AlternativeFormInfo>

GetFullNameDictionary()

Creates new dictionary for caching the objects by full name

[Obsolete("Method is no longer used by the system and will be removed.")]
[ObsoleteSince(30, 0)]
public ProviderInfoDictionary<string> GetFullNameDictionary()

Returns

ProviderInfoDictionary<string>

GetFullNameWhereCondition(string)

Gets the where condition that searches the object based on the given full name

[Obsolete("Method is no longer used by the system and will be removed.")]
[ObsoleteSince(30, 0)]
public IWhereCondition GetFullNameWhereCondition(string fullName)

Parameters

fullName string

Object full name

Returns

IWhereCondition

SetAlternativeFormInfo(AlternativeFormInfo)

Sets (updates or inserts) specified alternativeForm.

public static void SetAlternativeFormInfo(AlternativeFormInfo alternativeForm)

Parameters

alternativeForm AlternativeFormInfo

AlternativeForm to set

Validate(AlternativeFormInfo)

Validates whether the info object's state satisfies domain specific constraints and returns the validation result.

public override InfoValidationResult Validate(AlternativeFormInfo info)

Parameters

info AlternativeFormInfo

Info object to be validated.

Returns

InfoValidationResult

Returns validation result with IsValid set to true, if info is valid. Otherwise returns result with the flag set to false and a corresponding error message.

Remarks

Implement IInfoValidator<TInfo> and register it into the system to perform domain specific validation for AlternativeFormInfo. The system invokes the registered validators as part of validation performed by this method.

The default implementation validates the code name to contain only allowed characters and to be unique.

Exceptions

ArgumentNullException

Thrown when info is null.

See Also