Interface IShowProperty

Objects that implement this interface can be displayed

Namespace: CADability.UserInterface
Assembly: CADability.dll
Syntax
public interface IShowProperty

Properties

| Improve this Doc View Source

EntryType

Returns the type of the entry, see ShowPropertyEntryType.

Declaration
ShowPropertyEntryType EntryType { get; }
Property Value
Type Description
ShowPropertyEntryType
| Improve this Doc View Source

Returns the help link for the help control.

Declaration
string HelpLink { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Hidden

If an IShowProperty object is hidden, it will not appear in the TreeView of the control center. Most Properties are not hidden by default.

Declaration
bool Hidden { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

InfoText

Returns the text for the tooltip to display when the mouse cursor rests on the label.

Declaration
string InfoText { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IsSelected

Declaration
bool IsSelected { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

LabelText

Returns the label text, which is usually displayed on the left side of the control.

Declaration
string LabelText { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

LabelType

Returns the type of the label, see ShowPropertyLabelFlags.

Declaration
ShowPropertyLabelFlags LabelType { get; }
Property Value
Type Description
ShowPropertyLabelFlags
| Improve this Doc View Source

OwnerDrawHeight

Returns the height of this entry if it is ownerdrawn.

Declaration
int OwnerDrawHeight { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

ReadOnly

If an IShowProperty object is read only, its value should be fixed. The subProperties should also be read only.

Declaration
bool ReadOnly { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

SubEntries

Returns the array of subentries to this entry.

Declaration
IShowProperty[] SubEntries { get; }
Property Value
Type Description
IShowProperty[]
| Improve this Doc View Source

SubEntriesCount

Returns the number of subentries if any or 0 if none.

Declaration
int SubEntriesCount { get; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

Added(IPropertyTreeView)

Called when the entry was added to the control center or to a parent entry. The parameter represents the tree view object to which the entry was added. Each Added is later matched by a call to Removed(IPropertyTreeView).

Declaration
void Added(IPropertyTreeView propertyTreeView)
Parameters
Type Name Description
IPropertyTreeView propertyTreeView

the tree view
| Improve this Doc View Source

ChildSelected(IShowProperty)

Called when a child entry of this entry was selected.

Declaration
void ChildSelected(IShowProperty theSelectedChild)
Parameters
Type Name Description
IShowProperty theSelectedChild
| Improve this Doc View Source

LabelChanged(String)

Will be called when the text of a label changed because it was edited by the user. Will only be used if Editableis specified in the LabelType property.

Declaration
void LabelChanged(string NewText)
Parameters
Type Name Description
System.String NewText

the new text
| Improve this Doc View Source

OnEnterPressed()

Alt+Enter was pressed in the controlcenter while this entry was selected

Declaration
void OnEnterPressed()
| Improve this Doc View Source

OnVisibilityChanged(Boolean)

Declaration
void OnVisibilityChanged(bool isVisible)
Parameters
Type Name Description
System.Boolean isVisible
| Improve this Doc View Source

Opened(Boolean)

Notifies the item that its subitems will be shown (IsOpen==true) or that the treeview collapses the subitems (IsOpen==false). The Item should fire the StateChangedEvent event with the appropriate parameters.

Declaration
void Opened(bool IsOpen)
Parameters
Type Name Description
System.Boolean IsOpen

Treeview was opened or collpsed
| Improve this Doc View Source

Refresh()

Forces the entry to refresh its contents

Declaration
void Refresh()
| Improve this Doc View Source

Removed(IPropertyTreeView)

Matches the calls to Added(IPropertyTreeView). A good place to disconnect events and free resources.

Declaration
void Removed(IPropertyTreeView propertyTreeView)
Parameters
Type Name Description
IPropertyTreeView propertyTreeView
| Improve this Doc View Source

Select()

Forces this item to be selected in the treeview. The item must be visible.

Declaration
void Select()
| Improve this Doc View Source

Selected()

Called whent the entry was selected.

Declaration
void Selected()
| Improve this Doc View Source

SetFocus()

Will be called when the entry got the focus.

Declaration
void SetFocus()
| Improve this Doc View Source

SetTabIndex(ref Int32)

Do not use anymore.

Declaration
void SetTabIndex(ref int TabIndex)
Parameters
Type Name Description
System.Int32 TabIndex
| Improve this Doc View Source

ShowOpen(Boolean)

Opens this item to show the subentries of this item in the treeview, that contains this IShowProperty object. respectively closes or collapses this item to hide the subentries.

Declaration
void ShowOpen(bool open)
Parameters
Type Name Description
System.Boolean open

true: open, false: collapse
| Improve this Doc View Source

UnSelected()

Called whent the entry was unselected.

Declaration
void UnSelected()

Events

| Improve this Doc View Source

StateChangedEvent

Event that is fired when the state of this entry changed, e.g. the entry was selected.

Declaration
event StateChangedDelegate StateChangedEvent
Event Type
Type Description
StateChangedDelegate