Class ProjectItemMetadata

Metadata for a project item that is included in the project.

Inheritance
object
ProjectItemMetadata
Inherited Members
Namespace: Gorgon.Editor.Metadata
Assembly: Gorgon.Editor.API.dll
Syntax
[JsonObject(MemberSerialization = MemberSerialization.OptIn)]
public class ProjectItemMetadata

Constructors

| Edit this page View Source

ProjectItemMetadata()

Initializes a new instance of the ProjectItemMetadata class.

Declaration
public ProjectItemMetadata()
| Edit this page View Source

ProjectItemMetadata(ProjectItemMetadata)

Initializes a new instance of the ProjectItemMetadata class.

Declaration
public ProjectItemMetadata(ProjectItemMetadata metadata)
Parameters
Type Name Description
ProjectItemMetadata metadata

The metadata to copy.
Exceptions
Type Condition
ArgumentNullException

Thrown when the metadata parameter is null.

Properties

| Edit this page View Source

Attributes

Property to return the custom attributes for this metadata.

Declaration
[JsonProperty]
public Dictionary<string, string> Attributes { get; }
Property Value
Type Description
Dictionary<string, string>
| Edit this page View Source

ContentMetadata

Property to return the content plugin metadata associated with this project item.

Declaration
public IContentPlugInMetadata ContentMetadata { get; set; }
Property Value
Type Description
IContentPlugInMetadata
Remarks

Setting this value will set the value for PlugInName.

| Edit this page View Source

DependsOn

Property to return the list of item paths that this item depends on.

Declaration
[JsonProperty(PropertyName = "Dependencies")]
public Dictionary<string, List<string>> DependsOn { get; }
Property Value
Type Description
Dictionary<string, List<string>>
| Edit this page View Source

ID

Property to return the ID for the item.

Declaration
public string ID { get; }
Property Value
Type Description
string
| Edit this page View Source

PlugInName

Property to set or return the name of the plugin associated with the metadata file path.

Declaration
[JsonProperty]
public string PlugInName { get; set; }
Property Value
Type Description
string
Remarks

If this value is null, then the plugin hasn't been set. If it's an empty string, then no plugin is associated with this metadata.

| Edit this page View Source

Thumbnail

Property to set or return the name of the thumbnail associated with the project item.

Declaration
public string Thumbnail { get; set; }
Property Value
Type Description
string

Extension Methods