Class Folder

Inheritance

object

Folder

Implements

ITabularObjectContainer

IFolderObject

ITabularTableObject

ITabularNamedObject

ITabularObject

INotifyPropertyChanged

INamedObject

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace

TabularEditor.TOMWrapper

Assembly

TOMWrapper.dll

Represents a Folder in the TreeView. Does not correspond to any object in the TOM. Implements IDisplayFolderObject since a Folder can itself be located within another display folder. Implements IParentObject since a Folder can contain child objects.

public class Folder : ITabularObjectContainer, IFolderObject, ITabularTableObject, ITabularNamedObject, ITabularObject, INotifyPropertyChanged, INamedObject

Extension Methods

ScriptHelper.Output(object)

TabularObjectContainerHelper.GetChildrenRecursive(ITabularObjectContainer, bool)

Properties

DisplayFolder

[Browsable(false)]
public string DisplayFolder { get; set; }

Property Value

Type	Description
string

IsRemoved

[Browsable(false)]
public bool IsRemoved { get; }

Property Value

Type	Description
bool

MetadataIndex

[Browsable(false)]
public int MetadataIndex { get; }

Property Value

Type	Description
int

Model

[Browsable(false)]
public Model Model { get; }

Property Value

Type	Description
Model

Name

public string Name { get; set; }

Property Value

Type	Description
string

ObjectType

public ObjectType ObjectType { get; }

Property Value

Type	Description
ObjectType

ParentTable

[Browsable(false)]
public Table ParentTable { get; }

Property Value

Type	Description
Table

Path

public string Path { get; }

Property Value

Type	Description
string

Table

[Browsable(false)]
public Table Table { get; }

Property Value

Type	Description
Table

TranslatedDisplayFolders

[Browsable(false)]
public TranslationIndexer TranslatedDisplayFolders { get; }

Property Value

Type	Description
TranslationIndexer

Methods

CanDelete()

public bool CanDelete()

Returns

Type	Description
bool

CanDelete(out string)

public bool CanDelete(out string message)

Parameters

Type	Name	Description
string	message

Returns

Type	Description
bool

Delete()

Deleting a folder does not delete child objects - it just removes the folder. Any child folders are retained (but will be moved up the display folder hierarchy).

public void Delete()

Equals(object)

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Equals(Folder)

public bool Equals(Folder other)

Parameters

Type	Name	Description
Folder	other

Returns

Type	Description
bool

GetChildren()

public IEnumerable<ITabularNamedObject> GetChildren()

Returns

Type	Description
IEnumerable<ITabularNamedObject>

GetChildrenByFolders()

public IEnumerable<IFolderObject> GetChildrenByFolders()

Returns

Type	Description
IEnumerable<IFolderObject>

GetHashCode()

public override int GetHashCode()

Returns

Type	Description
int

SetFolderName(string)

public void SetFolderName(string newName)

Parameters

Type	Name	Description
string	newName

Events

PropertyChanged

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
PropertyChangedEventHandler

Operators

operator ==(Folder, Folder)

public static bool operator ==(Folder obj1, Folder obj2)

Parameters

Type	Name	Description
Folder	obj1
Folder	obj2

Returns

Type	Description
bool

operator !=(Folder, Folder)

public static bool operator !=(Folder obj1, Folder obj2)

Parameters

Type	Name	Description
Folder	obj1
Folder	obj2

Returns

Type	Description
bool