Interface ISchemaManagerSchema<TSchemaManagerSchema>
Typed intefrace of schema manager schemas.
Namespace: Terrasoft.Core
Assembly: Terrasoft.Core.dll
Syntax
public interface ISchemaManagerSchema<TSchemaManagerSchema>
where TSchemaManagerSchema : ISchemaManagerSchema<TSchemaManagerSchema>, IManagerItemInstance
Type Parameters
Name | Description |
---|---|
TSchemaManagerSchema | Type which implements ISchemaManagerSchema<TSchemaManagerSchema> and IManagerItemInstanceinterfaces. |
Properties
Caption
Schema caption.
Declaration
LocalizableString Caption { get; set; }
Property Value
Type | Description |
---|---|
LocalizableString |
Description
Schema description.
Declaration
LocalizableString Description { get; set; }
Property Value
Type | Description |
---|---|
LocalizableString |
IsCoreSchema
Attribute which identifies whether it is a system schema.
Declaration
bool IsCoreSchema { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Name
Schema name.
Declaration
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ParentSchema
Parent schema instance reference.
Declaration
TSchemaManagerSchema ParentSchema { get; set; }
Property Value
Type | Description |
---|---|
TSchemaManagerSchema |
ParentSchemaUId
Parent schema unique identifier.
Declaration
Guid ParentSchemaUId { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
ReferenceSchemaUIds
Schemas unique identifiers referenced by the current schema.
Declaration
Collection<Guid> ReferenceSchemaUIds { get; }
Property Value
Type | Description |
---|---|
System.Collections.ObjectModel.Collection<System.Guid> |
ResourceManager
Resource manager instance reference.
Declaration
IResourceManager ResourceManager { get; set; }
Property Value
Type | Description |
---|---|
IResourceManager |
UId
Global unique identifier.
Declaration
Guid UId { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Methods
AssignParentSchema(TSchemaManagerSchema)
Assigns parent schema to the current schema.
Declaration
bool AssignParentSchema(TSchemaManagerSchema parentSchema)
Parameters
Type | Name | Description |
---|---|---|
TSchemaManagerSchema | parentSchema | Parent schema. |
Returns
Type | Description |
---|---|
System.Boolean |
|
GetLocalizableValues(ICollection<LocalizableValue>)
Loads schema localizable values into specified collection.
Declaration
void GetLocalizableValues(ICollection<LocalizableValue> values)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.ICollection<LocalizableValue> | values | Collection to load localizable values to. |
GetLocalizableValues(ICollection<LocalizableValue>, Boolean)
Loads schema localizable values into specified collection.
Declaration
void GetLocalizableValues(ICollection<LocalizableValue> values, bool includeInherited)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.ICollection<LocalizableValue> | values | Collection to load localizable values to. |
System.Boolean | includeInherited | Indicates whether to include inherited properties. |
InitializeLocalizableValues(String)
Initializes schema localizable values.
Declaration
void InitializeLocalizableValues(string resourceManagerName)
Parameters
Type | Name | Description |
---|---|---|
System.String | resourceManagerName | Resource manager name. |
InitializeLocalizableValues(String, String)
Initializes schema localizable values from the specified resource manager group.
Declaration
void InitializeLocalizableValues(string resourceManagerName, string resourceGroupName)
Parameters
Type | Name | Description |
---|---|---|
System.String | resourceManagerName | Resource manager name. |
System.String | resourceGroupName | Resource group name. |
InitializePrimaryInfo()
Initializes schema main properties.
Declaration
void InitializePrimaryInfo()
SetDefInheritance()
Sets the current schema as a parent for all schema elements that do not have parent identifier defined.
Declaration
void SetDefInheritance()