Interface IPropertyEntry

Describes a single line in a tab page in the control center. Must be implemented by displayable properties like GeoPointProperty.

Namespace: CADability.UserInterface

Assembly: CADability.dll

Syntax

public interface IPropertyEntry

Properties

ContextMenu

Gets a ContextMenue for this entry

Declaration

MenuWithHandler[] ContextMenu { get; }

Property Value

Type	Description
MenuWithHandler[]

DeferUpdate

Only meaningful when ValueEditable is set. In this case the changes by typing do not notify the system until the text-box is closed (i.e. the focus leaves the text box)

Declaration

bool DeferUpdate { get; set; }

Property Value

Type	Description
System.Boolean

Flags

Gets the type of this entry

Declaration

PropertyEntryType Flags { get; }

Property Value

Type	Description
PropertyEntryType

IndentLevel

The indentation of this entry (according to it's position int the property tree). The implementer must simply keep this value

Declaration

int IndentLevel { get; set; }

Property Value

Type	Description
System.Int32

Index

The line number of this entry in the property page. The implementer must simply keep this value

Declaration

int Index { get; set; }

Property Value

Type	Description
System.Int32

IsOpen

Is the entry currently displayed with its sub-entries?

Declaration

bool IsOpen { get; set; }

Property Value

Type	Description
System.Boolean

Label

The label text

Declaration

string Label { get; }

Property Value

Type	Description
System.String

Parent

Gets or sets the parent. The implementer must simply keep this reference, it is either a IPropertyEntry or a IPropertyPage for the root objects

Declaration

object Parent { get; set; }

Property Value

Type	Description
System.Object

ReadOnly

Only meaningful when ValueEditable is set. If read-only is true, the value cannot be edited.

Declaration

bool ReadOnly { get; set; }

Property Value

Type	Description
System.Boolean

ResourceId

A tool-tip, or null if no tool-tip should be displayed

Declaration

string ResourceId { get; }

Property Value

Type	Description
System.String

SubItems

Returns the sub-items, will only be called when is set.

Declaration

IPropertyEntry[] SubItems { get; }

Property Value

Type	Description
IPropertyEntry[]

Value

The values text (may contain drawing hints like "[[ColorBox:0:128:255]]Pink")

Declaration

string Value { get; }

Property Value

Type	Description
System.String

Methods

Added(IPropertyPage)

Has been added to the property page, can be used to do some initialization.

Declaration

void Added(IPropertyPage pp)

Parameters

Type	Name	Description
IPropertyPage	pp	property page, it has been added to, keep it to use it for Refresh notification

ButtonClicked(PropertyEntryButton)

Declaration

void ButtonClicked(PropertyEntryButton button)

Parameters

Type	Name	Description
PropertyEntryButton	button

EditTextChanged(String)

The text being edited has changed

Declaration

bool EditTextChanged(string newValue)

Parameters

Type	Name	Description
System.String	newValue	The new text

Returns

Type	Description
System.Boolean	true, when the property would accept this value

EndEdit(Boolean, Boolean, String)

Notification when the editing process is being terminated.

Declaration

void EndEdit(bool aborted, bool modified, string newValue)

Parameters

Type	Name	Description
System.Boolean	aborted	true: the edit has been aborted, false: normal end of edit process
System.Boolean	modified
System.String	newValue

GetDropDownList()

Gets the list of choices (may contain drawing hints, like background color)

Declaration

string[] GetDropDownList()

Returns

Type	Description
System.String[]

ListBoxSelected(Int32)

The indicated selectedIndex has been selected in the listbox

Declaration

void ListBoxSelected(int selectedIndex)

Parameters

Type	Name	Description
System.Int32	selectedIndex

Opened(Boolean)

Notification for the entry that the open/closed state has changed

Declaration

void Opened(bool isOpen)

Parameters

Type	Name	Description
System.Boolean	isOpen	true: is now open (sub-entries are shown), false: is closed (sub-entries are hidden)

OpenOrCloseSubEntries()

if sub-entries are show, then hide them, if not, then show them (user clicked on the + or - symbol for opening or closing the sub-entries)

Declaration

int OpenOrCloseSubEntries()

Returns

Type	Description
System.Int32

Removed(IPropertyPage)

Has been removed from the property page

Declaration

void Removed(IPropertyPage pp)

Parameters

Type	Name	Description
IPropertyPage	pp

Select()

Select this entry

Declaration

void Select()

Selected(IPropertyEntry)

This item is now selected in the property page. The item previousSelected was selected before (may be null).

Declaration

void Selected(IPropertyEntry previousSelected)

Parameters

Type	Name	Description
IPropertyEntry	previousSelected

StartEdit(Boolean)

Declaration

void StartEdit(bool editValue)

Parameters

Type	Name	Description
System.Boolean	editValue

UnSelected(IPropertyEntry)

This item was selected in the property page but is no more selected. The item nowSelected will be selected instead (may be null).

Declaration

void UnSelected(IPropertyEntry nowSelected)

Parameters

Type	Name	Description
IPropertyEntry	nowSelected

Events

PropertyEntryChangedStateEvent

Declaration

event PropertyEntryChangedStateDelegate PropertyEntryChangedStateEvent

Event Type

Type	Description
PropertyEntryChangedStateDelegate