Interface IContentFile

A data structure representing a file containing content.

Inherited Members

IGorgonNamedObject.Name

Namespace: Gorgon.Editor.Content

Assembly: Gorgon.Editor.API.dll

Syntax

public interface IContentFile : IGorgonNamedObject

Properties

Extension

Property to return the extension for the file.

Declaration

string Extension { get; }

Property Value

Type	Description
string

IsChanged

Property to set or return whether the file has changes.

Declaration

bool IsChanged { get; set; }

Property Value

Type	Description
bool

IsOpen

Property to set or return whether the file is open for editing or not.

Declaration

bool IsOpen { get; set; }

Property Value

Type	Description
bool

Metadata

Property to return the metadata associated with the file.

Declaration

ProjectItemMetadata Metadata { get; }

Property Value

Type	Description
ProjectItemMetadata

Path

Property to return the path to the file.

Declaration

string Path { get; }

Property Value

Type	Description
string

Methods

ClearLinks()

Function to remove all child dependency links from this content.

Declaration

void ClearLinks()

LinkContent(IContentFile)

Function to link a content file to be dependant upon this content.

Declaration

void LinkContent(IContentFile file)

Parameters

Type	Name	Description
IContentFile	file	The file to link to this content.

Refresh()

Function called to refresh the information about the file.

Declaration

void Refresh()

RefreshMetadata()

Function to notify that the metadata should be refreshed.

Declaration

void RefreshMetadata()

UnlinkContent(IContentFile)

Function to unlink a content file from being dependant upon this content.

Declaration

void UnlinkContent(IContentFile file)

Parameters

Type	Name	Description
IContentFile	file	The file to unlink from this content.

Events

Renamed

Event triggered if this content file was renamed.

Declaration

event EventHandler<ContentFileRenamedEventArgs> Renamed

Event Type

Type	Description
EventHandler<ContentFileRenamedEventArgs>

Extension Methods

GorgonDebugExtensions.ValidateObject<T>(T, string)

GorgonNullExtensions.AsNullable<T>(object)

GorgonNullExtensions.IfNull<T>(object, T)

GorgonNullExtensions.IsNull(object)