Class Folder

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.

Inheritance
object
Folder
Implements
Inherited Members
Namespace: TabularEditor.TOMWrapper
Assembly: TOMWrapper.dll
Syntax
public class Folder : ITabularObjectContainer, IFolderObject, ITabularTableObject, ITabularNamedObject, ITabularObject, INotifyPropertyChanged, INamedObject

Properties

DisplayFolder

Declaration
[Browsable(false)]
public string DisplayFolder { get; set; }
Property Value
Type Description
string

IsRemoved

Declaration
[Browsable(false)]
public bool IsRemoved { get; }
Property Value
Type Description
bool

MetadataIndex

Declaration
[Browsable(false)]
public int MetadataIndex { get; }
Property Value
Type Description
int

Model

Declaration
[Browsable(false)]
public Model Model { get; }
Property Value
Type Description
Model

Name

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

ObjectType

Declaration
public ObjectType ObjectType { get; }
Property Value
Type Description
ObjectType

ParentTable

Declaration
[Browsable(false)]
public Table ParentTable { get; }
Property Value
Type Description
Table

Path

Declaration
public string Path { get; }
Property Value
Type Description
string

Table

Declaration
[Browsable(false)]
public Table Table { get; }
Property Value
Type Description
Table

TranslatedDisplayFolders

Declaration
[Browsable(false)]
public TranslationIndexer TranslatedDisplayFolders { get; }
Property Value
Type Description
TranslationIndexer

Methods

CanDelete()

Declaration
public bool CanDelete()
Returns
Type Description
bool

CanDelete(out string)

Declaration
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).

Declaration
public void Delete()

Equals(object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides

Equals(Folder)

Declaration
public bool Equals(Folder other)
Parameters
Type Name Description
Folder other
Returns
Type Description
bool

GetChildren()

Declaration
public IEnumerable<ITabularNamedObject> GetChildren()
Returns
Type Description
IEnumerable<ITabularNamedObject>

GetChildrenByFolders()

Declaration
public IEnumerable<IFolderObject> GetChildrenByFolders()
Returns
Type Description
IEnumerable<IFolderObject>

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

SetFolderName(string)

Declaration
public void SetFolderName(string newName)
Parameters
Type Name Description
string newName

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
PropertyChangedEventHandler

Operators

operator ==(Folder, Folder)

Declaration
public static bool operator ==(Folder obj1, Folder obj2)
Parameters
Type Name Description
Folder obj1
Folder obj2
Returns
Type Description
bool

operator !=(Folder, Folder)

Declaration
public static bool operator !=(Folder obj1, Folder obj2)
Parameters
Type Name Description
Folder obj1
Folder obj2
Returns
Type Description
bool

Implements

Extension Methods