Class FileEntry

Namespace

OmegaEngine.Foundation.Storage

Assembly

OmegaEngine.Foundation.dll

Describes a file returned by GetFileList(string, string).

public sealed class FileEntry : INamed, IHighlightColor, IContextMenu, IEquatable<FileEntry>, IComparable<FileEntry>

Inheritance

object

FileEntry

Implements

INamed

IHighlightColor

IContextMenu

IEquatable<FileEntry>

IComparable<FileEntry>

Inherited Members

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Extension Methods

XmlStorage.SaveXmlZip<T>(T, Stream, string?, params EmbeddedFile[])

XmlStorage.SaveXmlZip<T>(T, string, string?, params EmbeddedFile[])

XmlStorage.SaveXml<T>(T, Stream, string?)

XmlStorage.SaveXml<T>(T, string, string?)

XmlStorage.ToXmlString<T>(T, string?)

Properties

EntryType

The kind of file entry this is (in relation to its mod status).

public FileEntryType EntryType { get; set; }

Property Value

FileEntryType

FileType

The type of file (e.g. Textures, Sounds, ...).

public string FileType { get; }

Property Value

string

Remarks

This is only used for file operations and not for sorting!

HighlightColor

The color to highlight this file entry with in list representations. Empty for Normal (no highlighting). Blue for Modified. Green for Added. Red for Deleted.

public Color HighlightColor { get; }

Property Value

Color

Name

The relative file path.

public string Name { get; set; }

Property Value

string

Methods

Equals(FileEntry?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(FileEntry? other)

Parameters

other FileEntry

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetContextMenu()

Returns the context menu for this file entry; can be null.

public ContextMenuStrip? GetContextMenu()

Returns

ContextMenuStrip

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.