Interface IPropertyTreeView

Das Interface, das von dem PropertyDisplay Control zu Verfügung gestellt werden muss. CADability implementiert mit PropertyDisplay ein Control, welches dieses Interface zu Verfügung stellt. Das PropertyDisplay Control kann aber auch durch ein Control des Anwenders ersetzt werden. Dieses muss lediglich das IPropertyTreeView Interface implementieren.

Namespace: CADability.UserInterface

Assembly: CADability.dll

Syntax

public interface IPropertyTreeView

Properties

ActiveView

Liefert das aktive View Objekt. Dieses kann auch fehlen, dann wird null geliefert.

Declaration

IView ActiveView { get; set; }

Property Value

Type	Description
IView

AllIds

Declaration

string[] AllIds { get; }

Property Value

Type	Description
System.String[]

DefaultLineHeight

Liefert die Standard Zeilenhöhe der Anzeige

Declaration

int DefaultLineHeight { get; }

Property Value

Type	Description
System.Int32

Methods

AddShowProperty(IShowProperty, Boolean)

Fügt das im Parameter gegebene Objekt zur Anzeige hinzu.

Declaration

void AddShowProperty(IShowProperty ToAdd, bool TopMost)

Parameters

Type	Name	Description
IShowProperty	ToAdd	Dieses Objekt soll angezeigt werden
System.Boolean	TopMost	true: an oberster Stelle, false: an unterster Stelle.

ChildFocusChanged(IShowProperty, Boolean)

Declaration

void ChildFocusChanged(IShowProperty child, bool gotFocus)

Parameters

Type	Name	Description
IShowProperty	child
System.Boolean	gotFocus

Dispose()

Declaration

void Dispose()

FindFromHelpLink(String)

Finds the IShowProperty object with the given help link (HelpLink). The help link is used as a kind of unique id. It is usually the the resource id for the label text. If the desired entry is not visible it will not be found. You will first have to open the sub entries of the parent entry (OpenSubEntries(IShowProperty, Boolean)).

Declaration

IShowProperty FindFromHelpLink(string HelpLink)

Parameters

Type	Name	Description
System.String	HelpLink	The help link for the desired entry

Returns

Type	Description
IShowProperty	The IShowProperty entry

FocusEntered(IShowProperty, IShowProperty, IShowProperty)

Checks, whether a Focus change from oldFocus to newFocus implies a focus change to "toTest" or one of its child entries from some entry outside of "toTest". If newFocus is not toTest or one of its children "false" is returned. If the focus changes from one child of toTest to another or from a child of toTest to toTest itself or from toTest to one of its children, false is returned.

Declaration

bool FocusEntered(IShowProperty toTest, IShowProperty oldFocus, IShowProperty newFocus)

Parameters

Type	Name	Description
IShowProperty	toTest	the entry beeing examined
IShowProperty	oldFocus	the entry that lost the focus
IShowProperty	newFocus	the entry that got the focus

Returns

Type	Description
System.Boolean	true if toTest lost the focus

FocusLeft(IShowProperty, IShowProperty, IShowProperty)

Checks, whether a Focus change from oldFocus to newFocus implies a focus change from "toTest" or one of its child entries to some entry outside of "toTest". If oldFocus is not toTest or one of its children "false" is returned. If the focus changes from one child of toTest to another or from a child of toTest to toTest itself or from toTest to one of its children, false is returned.

Declaration

bool FocusLeft(IShowProperty toTest, IShowProperty oldFocus, IShowProperty newFocus)

Parameters

Type	Name	Description
IShowProperty	toTest	the entry beeing examined
IShowProperty	oldFocus	the entry that lost the focus
IShowProperty	newFocus	the entry that got the focus

Returns

Type	Description
System.Boolean	true if toTest lost the focus

GetBoundsForControl(Rectangle)

Declaration

Rectangle GetBoundsForControl(Rectangle position)

Parameters

Type	Name	Description
System.Drawing.Rectangle	position

Returns

Type	Description
System.Drawing.Rectangle

GetCurrentSelection()

Declaration

IShowProperty GetCurrentSelection()

Returns

Type	Description
IShowProperty

GetFrame()

Returns the IFrame object of the context of this IPropertyTreeView

Declaration

IFrame GetFrame()

Returns

Type	Description
IFrame

GetParent(IShowProperty)

Declaration

IShowProperty GetParent(IShowProperty child)

Parameters

Type	Name	Description
IShowProperty	child

Returns

Type	Description
IShowProperty

GetPointForControl(Point)

Declaration

Point GetPointForControl(Point loc)

Parameters

Type	Name	Description
System.Drawing.Point	loc

Returns

Type	Description
System.Drawing.Point

HasTopLevelShowProperty(IShowProperty)

Determins whether the given IShowProperty LookForThis is one of the root ShowProperties.

Declaration

bool HasTopLevelShowProperty(IShowProperty LookForThis)

Parameters

Type	Name	Description
IShowProperty	LookForThis	look for this IShowProperty object

Returns

Type	Description
System.Boolean	true, if LookForThis is a root ShowProperty, false otherwise

IsOnTop()

Determins whether this IPropertyTreeView is on top of all IPropertyTreeView objects. Several IPropertyTreeViews reside in the ControlCenter in different tab pages. Determins whether this IPropertyTreeView is in the selected tab page.

Declaration

bool IsOnTop()

Returns

Type	Description
System.Boolean	true if on top, false otherwise

IsOpen(IShowProperty)

Declaration

bool IsOpen(IShowProperty toTest)

Parameters

Type	Name	Description
IShowProperty	toTest

Returns

Type	Description
System.Boolean

MakeVisible(IShowProperty)

Das im Parameter gegebene Objekt soll sichtbar dargestellt werden.

Declaration

void MakeVisible(IShowProperty ToShow)

Parameters

Type	Name	Description
IShowProperty	ToShow	Das anzuzeigende Objekt.

OpenSubEntries(IShowProperty, Boolean)

Die Untereinträge des im Parameter gegebenen Objektes sollenn (erzeugt und) sichtbar sein.

Declaration

void OpenSubEntries(IShowProperty ToOpen, bool open)

Parameters

Type	Name	Description
IShowProperty	ToOpen
System.Boolean	open

PopupContextMenu(IShowProperty)

Declaration

void PopupContextMenu(IShowProperty entry)

Parameters

Type	Name	Description
IShowProperty	entry

Refresh(IShowProperty)

Das im Parameter gegebene Objekt muss neu dargestellt werden. Z.B wenn sich die Liste der Unterobjekte geändert hat.

Declaration

void Refresh(IShowProperty ToRefresh)

Parameters

Type	Name	Description
IShowProperty	ToRefresh	Das neu darzustellende Objekt.

RemoveShowProperty(IShowProperty)

Das im Parameter gegebene Objekt soll nicht mehr angezeigt werden.

Declaration

void RemoveShowProperty(IShowProperty ToRemove)

Parameters

Type	Name	Description
IShowProperty	ToRemove	Die zu entfernende Anzeige.

ReplaceShowProperty(IShowProperty, IShowProperty)

Ersetzt eine Anzeige durch eine andere.

Declaration

void ReplaceShowProperty(IShowProperty ToReplace, IShowProperty ToInsert)

Parameters

Type	Name	Description
IShowProperty	ToReplace	Die zu ersetzende Anzeige
IShowProperty	ToInsert	Die neue Anzeige

SelectEntry(IShowProperty)

Das im Parameter gegebene Objekt soll markiert dargestellt werden.

Declaration

void SelectEntry(IShowProperty NewSelection)

Parameters

Type	Name	Description
IShowProperty	NewSelection	Das neu zu markierende objekt.

SelectNext(IShowProperty, Boolean)

Die Untereinträge des im Parameter gegebenen Objektes sollenn (erzeugt und) sichtbar sein.

Declaration

void SelectNext(IShowProperty CurrentProperty, bool Forward)

Parameters

Type	Name	Description
IShowProperty	CurrentProperty
System.Boolean	Forward	=wahr setzt den Fukus auf das nächste Objekt der Tab-Reighenfolge, = falsch auf das verhergehende

SetFont(Font)

Declaration

void SetFont(Font font)

Parameters

Type	Name	Description
System.Drawing.Font	font

StartEditLabel(IShowProperty)

Der LabelText des im Parameter gegebenen Objektes soll editiert werden.

Declaration

void StartEditLabel(IShowProperty ToEdit)

Parameters

Type	Name	Description
IShowProperty	ToEdit	Das zu editiernde Objekt

Events

FocusChangedEvent

Declaration

event FocusChangedDelegate FocusChangedEvent

Event Type

Type	Description
FocusChangedDelegate