Table of Contents

Class WindowsFile

Namespace
CENTREL.XIA.Configuration.Types
Assembly
CENTREL.XIA.Configuration.Types.dll

Represents an individual file found on a Windows based computer system.

public class WindowsFile : GlobalSerializableClassicBase, IComparable<WindowsFile>
Inheritance
WindowsFile
Implements

Constructors

WindowsFile()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.WindowsFile class.

public WindowsFile()

WindowsFile(string)

Initializes a new instance of the CENTREL.XIA.Configuration.Types.WindowsFile class.

public WindowsFile(string displayName)

Parameters

displayName string

The unique display name of this file.

Properties

DisplayName

Gets or sets the unique administrator assigned display name of this file.

public string DisplayName { get; set; }

Property Value

string

Remarks

In the case where a single file may be in different locations with different names this allows the file to be referenced using a unique ID.

Information

Gets or sets information about the file.

public WindowsFileInformation Information { get; set; }

Property Value

WindowsFileInformation

Located

Gets or sets whether this file was located on the file system.

public BooleanOption Located { get; set; }

Property Value

BooleanOption

SearchLocations

Gets or sets the search locations for the file.

public SerializableStringCollection SearchLocations { get; set; }

Property Value

SerializableStringCollection

Methods

CompareTo(WindowsFile)

Compares two CENTREL.XIA.Configuration.Types.WindowsFile to allow sorting by display name.

public int CompareTo(WindowsFile other)

Parameters

other WindowsFile

The CENTREL.XIA.Configuration.Types.WindowsFile to compare to.

Returns

int

The sort order of the two CENTREL.XIA.Configuration.Types.WindowsFile objects.

ToString()

Returns the Windows file as a human readable string.

public override string ToString()

Returns

string

The Windows file as a human readable string.