Class DataTypeService
Represents the DataType Service, which is an easy access to operations involving IDataTypeDefinition
Inheritance
System.Object
Namespace:System.Dynamic.ExpandoObject
Assembly:Umbraco.Core.dll
Syntax
public class DataTypeService : ScopeRepositoryService, IDataTypeService, IService
Constructors
DataTypeService(IDatabaseUnitOfWorkProvider, RepositoryFactory, ILogger, IEventMessagesFactory)
Declaration
public DataTypeService(IDatabaseUnitOfWorkProvider provider, RepositoryFactory repositoryFactory, ILogger logger, IEventMessagesFactory eventMessagesFactory)
Parameters
Methods
CreateContainer(Int32, String, Int32)
Declaration
public 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
Delete(IDataTypeDefinition, Int32)
Declaration
public void Delete(IDataTypeDefinition dataTypeDefinition, int userId = 0)
Parameters
DeleteContainer(Int32, Int32)
Declaration
public Attempt<OperationStatus> DeleteContainer(int containerId, int userId = 0)
Parameters
Type |
Name |
Description |
System.Int32 |
containerId |
|
System.Int32 |
userId |
|
Returns
GetAllDataTypeDefinitions(Int32[])
Declaration
public IEnumerable<IDataTypeDefinition> GetAllDataTypeDefinitions(params int[] ids)
Parameters
Type |
Name |
Description |
System.Int32[] |
ids |
Optional array of Ids
|
Returns
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")]
public IEnumerable<IDataType> GetAllDataTypes()
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<umbraco.interfaces.IDataType> |
An enumerable list of umbraco.interfaces.IDataType objects
|
GetContainer(Guid)
Declaration
public EntityContainer GetContainer(Guid containerId)
Parameters
Type |
Name |
Description |
System.Guid |
containerId |
|
Returns
GetContainer(Int32)
Declaration
public EntityContainer GetContainer(int containerId)
Parameters
Type |
Name |
Description |
System.Int32 |
containerId |
|
Returns
GetContainers(Int32[])
Declaration
public IEnumerable<EntityContainer> GetContainers(int[] containerIds)
Parameters
Type |
Name |
Description |
System.Int32[] |
containerIds |
|
Returns
GetContainers(String, Int32)
Declaration
public IEnumerable<EntityContainer> GetContainers(string name, int level)
Parameters
Type |
Name |
Description |
System.String |
name |
|
System.Int32 |
level |
|
Returns
GetContainers(IDataTypeDefinition)
Declaration
public IEnumerable<EntityContainer> GetContainers(IDataTypeDefinition dataTypeDefinition)
Parameters
Returns
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")]
public 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)
Declaration
[Obsolete("Property editor's are defined by a string alias from version 7 onwards, use the overload GetDataTypeDefinitionByPropertyEditorAlias instead")]
public IEnumerable<IDataTypeDefinition> GetDataTypeDefinitionByControlId(Guid id)
Parameters
Type |
Name |
Description |
System.Guid |
id |
Id of the DataType control
|
Returns
GetDataTypeDefinitionById(Guid)
Declaration
public IDataTypeDefinition GetDataTypeDefinitionById(Guid id)
Parameters
Type |
Name |
Description |
System.Guid |
id |
Unique guid Id of the DataType
|
Returns
GetDataTypeDefinitionById(Int32)
Declaration
public IDataTypeDefinition GetDataTypeDefinitionById(int id)
Parameters
Returns
GetDataTypeDefinitionByName(String)
Declaration
public IDataTypeDefinition GetDataTypeDefinitionByName(string name)
Parameters
Returns
GetDataTypeDefinitionByPropertyEditorAlias(String)
Declaration
public IEnumerable<IDataTypeDefinition> GetDataTypeDefinitionByPropertyEditorAlias(string propertyEditorAlias)
Parameters
Type |
Name |
Description |
System.String |
propertyEditorAlias |
Alias of the property editor
|
Returns
GetPreValueAsString(Int32)
Gets a specific PreValue by its Id
Declaration
public 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)
Declaration
public IEnumerable<string> GetPreValuesByDataTypeId(int id)
Parameters
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<System.String> |
An enumerable list of string values
|
GetPreValuesCollectionByDataTypeId(Int32)
Returns the PreValueCollection for the specified data type
Declaration
public PreValueCollection GetPreValuesCollectionByDataTypeId(int id)
Parameters
Type |
Name |
Description |
System.Int32 |
id |
|
Returns
Move(IDataTypeDefinition, Int32)
Declaration
public Attempt<OperationStatus<MoveOperationStatusType>> Move(IDataTypeDefinition toMove, int parentId)
Parameters
Returns
Save(IEnumerable<IDataTypeDefinition>, Int32)
Declaration
public void Save(IEnumerable<IDataTypeDefinition> dataTypeDefinitions, int userId = 0)
Parameters
Save(IEnumerable<IDataTypeDefinition>, Int32, Boolean)
Declaration
public 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)
Declaration
public void Save(IDataTypeDefinition dataTypeDefinition, int userId = 0)
Parameters
SaveContainer(EntityContainer, Int32)
Declaration
public Attempt<OperationStatus> SaveContainer(EntityContainer container, int userId = 0)
Parameters
Returns
SaveDataTypeAndPreValues(IDataTypeDefinition, IDictionary<String, PreValue>, Int32)
This will save a data type and it's pre-values in one transaction
Declaration
public 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/updates the pre-values
Declaration
public void SavePreValues(int dataTypeId, IDictionary<string, PreValue> values)
Parameters
Type |
Name |
Description |
System.Int32 |
dataTypeId |
|
System.Collections.Generic.IDictionary<System.String, PreValue> |
values |
|
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")]
public 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/updates the pre-values
Declaration
public void SavePreValues(IDataTypeDefinition dataTypeDefinition, IDictionary<string, PreValue> values)
Parameters
Events
Deleted
Declaration
public static event TypedEventHandler<IDataTypeService, DeleteEventArgs<IDataTypeDefinition>> Deleted
Event Type
DeletedContainer
Declaration
public static event TypedEventHandler<IDataTypeService, DeleteEventArgs<EntityContainer>> DeletedContainer
Event Type
Deleting
Declaration
public static event TypedEventHandler<IDataTypeService, DeleteEventArgs<IDataTypeDefinition>> Deleting
Event Type
DeletingContainer
Declaration
public static event TypedEventHandler<IDataTypeService, DeleteEventArgs<EntityContainer>> DeletingContainer
Event Type
Moved
Declaration
public static event TypedEventHandler<IDataTypeService, MoveEventArgs<IDataTypeDefinition>> Moved
Event Type
Moving
Declaration
public static event TypedEventHandler<IDataTypeService, MoveEventArgs<IDataTypeDefinition>> Moving
Event Type
Saved
Declaration
public static event TypedEventHandler<IDataTypeService, SaveEventArgs<IDataTypeDefinition>> Saved
Event Type
SavedContainer
Declaration
public static event TypedEventHandler<IDataTypeService, SaveEventArgs<EntityContainer>> SavedContainer
Event Type
Saving
Declaration
public static event TypedEventHandler<IDataTypeService, SaveEventArgs<IDataTypeDefinition>> Saving
Event Type
SavingContainer
Declaration
public static event TypedEventHandler<IDataTypeService, SaveEventArgs<EntityContainer>> SavingContainer
Event Type