Class ConstructAction.StringInput
Defines an input object for an action derived from ConstructAction.
This input object extpects the user to enter a string in a edit field.
Pressing enter or TAB or clicking the mouse proceeds to the next input object.
Inheritance
System.Object
ConstructAction.StringInput
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: CADability.dll
public class StringInput : ConstructAction.InputObject, ConstructAction.IInputObject, ICommandHandler
Constructors
|
Improve this Doc
View Source
Declaration
public StringInput(string resourceId)
Parameters
| Type |
Name |
Description |
| System.String |
resourceId |
the resource id to specify a string from the StringTable.
ResourceId+".Label": the Label left of the
edit box. ResourceId+".ShortInfo": a short tooltip text ResourceId+"DetailedInfo":
a longer tooltip text.
|
Fields
|
Improve this Doc
View Source
Only used when IsFileNameInput is true. This is the filter for the
file open dialog.
Declaration
public string FileNameFilter
Field Value
| Type |
Description |
| System.String |
|
|
Improve this Doc
View Source
If true there will be an file open dialog when this input becomes visible.
Declaration
Field Value
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
If true, this input can be used as a file open dialog input. In the corresponding context menu
the file open dialog can be opened.
Declaration
public bool IsFileNameInput
Field Value
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
Declaration
public bool NotifyOnLostFocusOnly
Field Value
| Type |
Description |
| System.Boolean |
|
Properties
|
Improve this Doc
View Source
Content
Declaration
public string Content { get; set; }
Property Value
| Type |
Description |
| System.String |
|
|
Improve this Doc
View Source
Mouse input should be forwarded to another input object and only processed
by this input, when the other input object is fixed.
Declaration
public object ForwardMouseInputTo { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
Methods
|
Improve this Doc
View Source
ConnectWithTextObject(Text, IView)
Connects this input filed with a Text object.
The Text object displays the carret in the view so you can edit the text
in the view directly
Declaration
public void ConnectWithTextObject(Text text, IView vw)
Parameters
| Type |
Name |
Description |
| Text |
text |
the text object
|
| IView |
vw |
the view, in which the editing is supposed to happen
|
Events
|
Improve this Doc
View Source
Provide a method here when the string also changes by other means than user input.
Declaration
public event ConstructAction.StringInput.GetStringDelegate GetStringEvent
Event Type
|
Improve this Doc
View Source
Provide a handler here if you want to be notified about input changes.
Declaration
public event ConstructAction.StringInput.SetStringDelegate SetStringEvent
Event Type
Explicit Interface Implementations
|
Improve this Doc
View Source
Declaration
bool ICommandHandler.OnCommand(string MenuId)
Parameters
| Type |
Name |
Description |
| System.String |
MenuId |
|
Returns
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
Declaration
void ICommandHandler.OnSelected(MenuWithHandler selectedMenuItem, bool selected)
Parameters
| Type |
Name |
Description |
| MenuWithHandler |
selectedMenuItem |
|
| System.Boolean |
selected |
|
|
Improve this Doc
View Source
Declaration
bool ICommandHandler.OnUpdateCommand(string MenuId, CommandState CommandState)
Parameters
| Type |
Name |
Description |
| System.String |
MenuId |
|
| CommandState |
CommandState |
|
Returns
| Type |
Description |
| System.Boolean |
|
Implements