Class Metadata
Defines a metadata that consists of one or several metadata values of the same definition.
Inheritance
Namespace: ImageVault.Common.Data
Assembly: ImageVault.Common.dll
Syntax
public abstract class Metadata : ObjectConstructors
Metadata()
Initializes a new instance of the Metadata class.
Declaration
protected Metadata()Metadata(Metadata)
Initializes a new instance of the Metadata class.
Declaration
protected Metadata(Metadata metadata)Parameters
| Type | Name | Description |
|---|---|---|
| Metadata | metadata |
Metadata(MetadataDefinition, Nullable<Int32>, Boolean, Boolean, Boolean, Boolean)
Initializes a new instance of the Metadata class.
Declaration
protected Metadata(MetadataDefinition definition, Nullable<int> languageId, bool isMandantory, bool isTitle, bool isAltText, bool isDefinedInVault)Parameters
| Type | Name | Description |
|---|---|---|
| MetadataDefinition | definition | |
| System.Nullable<System.Int32> | languageId | |
| System.Boolean | isMandantory | |
| System.Boolean | isTitle | |
| System.Boolean | isAltText | |
| System.Boolean | isDefinedInVault |
Properties
DefinitionType
Get/Sets the DefinitionType of the Metadata
Declaration
public MetadataDefinitionTypes DefinitionType { get; }Property Value
| Type | Description |
|---|---|
| MetadataDefinitionTypes |
Description
Gets/sets the description of the Metadata
Declaration
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
InnerValue
Get/Sets the InnerValue of the Metadata
Declaration
protected abstract object InnerValue { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The value for all metadata objects. If IsCoherent is false this only contains the value of the first item |
IsAltText
Get/Sets the IsDefaultAltText of the Metadata
Declaration
public bool IsAltText { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | If true this is the default alt text in the vault |
IsCoherent
Get/Sets the IsCoherent of the Metadata
Declaration
public bool IsCoherent { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | If true all metadata that was used to create the condensed value has the same value |
IsDefinedInVault
Get/Sets the IsDefinedInVault of the Metadata
Declaration
public bool IsDefinedInVault { get; protected set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | True if this metadata is defined in the vault that the item resides in. |
IsMandantory
Get/Sets the IsMandantory of the Metadata
Declaration
public bool IsMandantory { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | If true the metadata is mandantory in at least one vault that it is part of |
IsMultilingual
If the matadata can existis for multiple languages
Declaration
public bool IsMultilingual { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsNull
Get/Sets the IsNull of the Metadata
Declaration
public bool IsNull { get; protected set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | If true the value is not set, false if it is set to a non null value |
IsReadOnly
If user can change metadata
Declaration
public bool IsReadOnly { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsTitle
Get/Sets the IsDefaultTitle of the Metadata
Declaration
public bool IsTitle { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | If true this is default title in the vault |
LanguageId
Get/Sets the LanguageId of the Metadata
Declaration
public Nullable<int> LanguageId { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> | The id of the language of the metadata |
MetadataDefinitionId
Get/Sets the MetadataDefinitionId of the Metadata
Declaration
public int MetadataDefinitionId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Name
Get/Sets the Name of the Metadata
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
SymbolKey
If the matadata should be shown as a symbol
Declaration
public string SymbolKey { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Value
Get/Sets the Value of the Metadata
Declaration
public object Value { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object |
Methods
CreateInstance(MetadataDefinition, Nullable<Int32>, Boolean, Boolean, Boolean, Boolean)
Creates an instance of a metadata that matches the supplied definition
Declaration
public static Metadata CreateInstance(MetadataDefinition definition, Nullable<int> languageId, bool isMandantory, bool isTitle, bool isAltText, bool isDefinedInVault)Parameters
| Type | Name | Description |
|---|---|---|
| MetadataDefinition | definition | The MetadataDefinition to use as a base for creating the Metadata |
| System.Nullable<System.Int32> | languageId | The id of the language to use for creating the metadata |
| System.Boolean | isMandantory | If the metadata is mandatory or not |
| System.Boolean | isTitle | |
| System.Boolean | isAltText | |
| System.Boolean | isDefinedInVault |
Returns
| Type | Description |
|---|---|
| Metadata |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | If |
| System.NotImplementedException | If not implemented Metadata for type . |
Parse(String)
Parses the supplied value and assigns it to the metadata
Declaration
public abstract void Parse(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |