Interface IDataTypeService
Defines the DataType Service, which is an easy access to operations involving IDataTypeDefinition
Namespace:System.Dynamic.ExpandoObject
Assembly:Umbraco.Core.dll
Syntax
public interface IDataTypeService : IService
Methods
CreateContainer(Int32, String, Int32)
Declaration
Attempt<OperationStatus<EntityContainer, OperationStatusType>> CreateContainer(int parentId, string name, int userId = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | parentId | |
System.String | name | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
Attempt<OperationStatus<EntityContainer, OperationStatusType>> |
Delete(IDataTypeDefinition, Int32)
Deletes an IDataTypeDefinition
Declaration
void Delete(IDataTypeDefinition dataTypeDefinition, int userId = 0)
Parameters
Type | Name | Description |
---|---|---|
IDataTypeDefinition | dataTypeDefinition | IDataTypeDefinition to delete |
System.Int32 | userId | Id of the user issueing the deletion |
Remarks
Please note that deleting a IDataTypeDefinition will remove all the PropertyType data that references this IDataTypeDefinition.
DeleteContainer(Int32, Int32)
Declaration
Attempt<OperationStatus> DeleteContainer(int containerId, int userId = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | containerId | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
Attempt<OperationStatus> |
GetAllDataTypeDefinitions(Int32[])
Gets all IDataTypeDefinition objects or those with the ids passed in
Declaration
IEnumerable<IDataTypeDefinition> GetAllDataTypeDefinitions(params int[] ids)
Parameters
Type | Name | Description |
---|---|---|
System.Int32[] | ids | Optional array of Ids |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IDataTypeDefinition> | An enumerable list of IDataTypeDefinition objects |
GetAllDataTypes()
Gets a complete list of all registered umbraco.interfaces.IDataType's
Declaration
[Obsolete("IDataType is obsolete and is no longer used, it will be removed from the codebase in future versions")]
IEnumerable<IDataType> GetAllDataTypes()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<umbraco.interfaces.IDataType> | An enumerable list of umbraco.interfaces.IDataType objects |
GetContainer(Guid)
Declaration
EntityContainer GetContainer(Guid containerId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | containerId |
Returns
Type | Description |
---|---|
EntityContainer |
GetContainer(Int32)
Declaration
EntityContainer GetContainer(int containerId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | containerId |
Returns
Type | Description |
---|---|
EntityContainer |
GetContainers(Int32[])
Declaration
IEnumerable<EntityContainer> GetContainers(int[] containerIds)
Parameters
Type | Name | Description |
---|---|---|
System.Int32[] | containerIds |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<EntityContainer> |
GetContainers(String, Int32)
Declaration
IEnumerable<EntityContainer> GetContainers(string folderName, int level)
Parameters
Type | Name | Description |
---|---|---|
System.String | folderName | |
System.Int32 | level |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<EntityContainer> |
GetContainers(IDataTypeDefinition)
Declaration
IEnumerable<EntityContainer> GetContainers(IDataTypeDefinition dataTypeDefinition)
Parameters
Type | Name | Description |
---|---|---|
IDataTypeDefinition | dataTypeDefinition |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<EntityContainer> |
GetDataTypeById(Guid)
Gets the umbraco.interfaces.IDataType specified by it's unique ID
Declaration
[Obsolete("IDataType is obsolete and is no longer used, it will be removed from the codebase in future versions")]
IDataType GetDataTypeById(Guid id)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | Id of the DataType, which corresponds to the Guid Id of the control |
Returns
Type | Description |
---|---|
umbraco.interfaces.IDataType | umbraco.interfaces.IDataType object |
GetDataTypeDefinitionByControlId(Guid)
Gets a IDataTypeDefinition by its control Id
Declaration
[Obsolete("Property editor's are defined by a string alias from version 7 onwards, use the overload GetDataTypeDefinitionByPropertyEditorAlias instead")]
IEnumerable<IDataTypeDefinition> GetDataTypeDefinitionByControlId(Guid id)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | Id of the DataType control |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IDataTypeDefinition> | IDataTypeDefinition |
GetDataTypeDefinitionById(Guid)
Gets a IDataTypeDefinition by its unique guid Id
Declaration
IDataTypeDefinition GetDataTypeDefinitionById(Guid id)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | Unique guid Id of the DataType |
Returns
Type | Description |
---|---|
IDataTypeDefinition | IDataTypeDefinition |
GetDataTypeDefinitionById(Int32)
Gets a IDataTypeDefinition by its Id
Declaration
IDataTypeDefinition GetDataTypeDefinitionById(int id)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | Id of the IDataTypeDefinition |
Returns
Type | Description |
---|---|
IDataTypeDefinition | IDataTypeDefinition |
GetDataTypeDefinitionByName(String)
Gets a IDataTypeDefinition by its Name
Declaration
IDataTypeDefinition GetDataTypeDefinitionByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the IDataTypeDefinition |
Returns
Type | Description |
---|---|
IDataTypeDefinition | IDataTypeDefinition |
GetDataTypeDefinitionByPropertyEditorAlias(String)
Gets a IDataTypeDefinition by its control Id
Declaration
IEnumerable<IDataTypeDefinition> GetDataTypeDefinitionByPropertyEditorAlias(string propertyEditorAlias)
Parameters
Type | Name | Description |
---|---|---|
System.String | propertyEditorAlias | Alias of the property editor |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IDataTypeDefinition> | Collection of IDataTypeDefinition objects with a matching contorl id |
GetPreValueAsString(Int32)
Gets a specific PreValue by its Id
Declaration
string GetPreValueAsString(int id)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | Id of the PreValue to retrieve the value from |
Returns
Type | Description |
---|---|
System.String | PreValue as a string |
GetPreValuesByDataTypeId(Int32)
Gets all values for an IDataTypeDefinition
Declaration
IEnumerable<string> GetPreValuesByDataTypeId(int id)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | Id of the IDataTypeDefinition to retrieve prevalues from |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | An enumerable list of string values |
GetPreValuesCollectionByDataTypeId(Int32)
Gets a pre-value collection by data type id
Declaration
PreValueCollection GetPreValuesCollectionByDataTypeId(int id)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id |
Returns
Type | Description |
---|---|
PreValueCollection |
Move(IDataTypeDefinition, Int32)
Declaration
Attempt<OperationStatus<MoveOperationStatusType>> Move(IDataTypeDefinition toMove, int parentId)
Parameters
Type | Name | Description |
---|---|---|
IDataTypeDefinition | toMove | |
System.Int32 | parentId |
Returns
Type | Description |
---|---|
Attempt<OperationStatus<MoveOperationStatusType>> |
Save(IEnumerable<IDataTypeDefinition>, Int32)
Saves a collection of IDataTypeDefinition
Declaration
void Save(IEnumerable<IDataTypeDefinition> dataTypeDefinitions, int userId = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<IDataTypeDefinition> | dataTypeDefinitions | IDataTypeDefinition to save |
System.Int32 | userId | Id of the user issueing the save |
Save(IEnumerable<IDataTypeDefinition>, Int32, Boolean)
Saves a collection of IDataTypeDefinition
Declaration
void Save(IEnumerable<IDataTypeDefinition> dataTypeDefinitions, int userId, bool raiseEvents)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<IDataTypeDefinition> | dataTypeDefinitions | IDataTypeDefinition to save |
System.Int32 | userId | Id of the user issueing the save |
System.Boolean | raiseEvents | Boolean indicating whether or not to raise events |
Save(IDataTypeDefinition, Int32)
Saves an IDataTypeDefinition
Declaration
void Save(IDataTypeDefinition dataTypeDefinition, int userId = 0)
Parameters
Type | Name | Description |
---|---|---|
IDataTypeDefinition | dataTypeDefinition | IDataTypeDefinition to save |
System.Int32 | userId | Id of the user issueing the save |
SaveContainer(EntityContainer, Int32)
Declaration
Attempt<OperationStatus> SaveContainer(EntityContainer container, int userId = 0)
Parameters
Type | Name | Description |
---|---|---|
EntityContainer | container | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
Attempt<OperationStatus> |
SaveDataTypeAndPreValues(IDataTypeDefinition, IDictionary<String, PreValue>, Int32)
Saves the data type and it's prevalues
Declaration
void SaveDataTypeAndPreValues(IDataTypeDefinition dataTypeDefinition, IDictionary<string, PreValue> values, int userId = 0)
Parameters
Type | Name | Description |
---|---|---|
IDataTypeDefinition | dataTypeDefinition | |
System.Collections.Generic.IDictionary<System.String, PreValue> | values | |
System.Int32 | userId |
SavePreValues(Int32, IDictionary<String, PreValue>)
Saves a list of PreValues for a given DataTypeDefinition
Declaration
void SavePreValues(int dataTypeId, IDictionary<string, PreValue> values)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | dataTypeId | Id of the DataTypeDefinition to save PreValues for |
System.Collections.Generic.IDictionary<System.String, PreValue> | values | List of key/value pairs to save |
SavePreValues(Int32, IEnumerable<String>)
Saves a list of PreValues for a given DataTypeDefinition
Declaration
[Obsolete("This should no longer be used, use the alternative SavePreValues or SaveDataTypeAndPreValues methods instead. This will only insert pre-values without keys")]
void SavePreValues(int dataTypeId, IEnumerable<string> values)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | dataTypeId | Id of the DataTypeDefinition to save PreValues for |
System.Collections.Generic.IEnumerable<System.String> | values | List of string values to save |
SavePreValues(IDataTypeDefinition, IDictionary<String, PreValue>)
Saves a list of PreValues for a given DataTypeDefinition
Declaration
void SavePreValues(IDataTypeDefinition dataTypeDefinition, IDictionary<string, PreValue> values)
Parameters
Type | Name | Description |
---|---|---|
IDataTypeDefinition | dataTypeDefinition | The DataTypeDefinition to save PreValues for |
System.Collections.Generic.IDictionary<System.String, PreValue> | values | List of key/value pairs to save |