Class ConstructAction.GeoPointInput

Defines an input object for an action derived from ConstructAction. This input object extpects the input of a point. This point may be either entered on the keyboard or by moving the mouse. Pressing enter or TAB or clicking the mouse proceeds to the next input object.

Inheritance
System.Object
ConstructAction.InputObject
ConstructAction.GeoPointInput
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()
Namespace: CADability.Actions
Assembly: CADability.dll
Syntax
public class GeoPointInput : ConstructAction.InputObject, ConstructAction.IInputObject

Constructors

| Improve this Doc View Source

GeoPointInput(String)

Constructs a GeoPointInput object.

Declaration
public GeoPointInput(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.
| Improve this Doc View Source

GeoPointInput(String, GeoPoint)

Constructs a GeoPointInput object with an inital value.

Declaration
public GeoPointInput(string resourceId, GeoPoint StartValue)
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.
GeoPoint StartValue

the initial value

Fields

| Improve this Doc View Source

DefinesBasePoint

If set to true this point is the basepoint for snapping.

Declaration
public bool DefinesBasePoint
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

DefinesHotSpot

true: the point is displayed as hotspot (small sqaure). The user can drag this hotspot with the mouse to modify this input.

Declaration
public bool DefinesHotSpot
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

HotSpotSource

The icon for the hotspot, for example "Hotspots.png:3"

Declaration
public string HotSpotSource
Field Value
Type Description
System.String

Properties

| Improve this Doc View Source

DefaultGeoPoint

Sets a DefaultGeoPoint, which should be a static value, that carries the last input value of this point to the next instantiation of the action.

Declaration
public ConstructAction.DefaultGeoPoint DefaultGeoPoint { set; }
Property Value
Type Description
ConstructAction.DefaultGeoPoint
| Improve this Doc View Source

ForwardMouseInputTo

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
| Improve this Doc View Source

Point

Declaration
public GeoPoint Point { get; }
Property Value
Type Description
GeoPoint
| Improve this Doc View Source

ReadOnly

true: this input field does not accept user input, false: normal input field that requires user input

Declaration
public override bool ReadOnly { get; set; }
Property Value
Type Description
System.Boolean
Overrides

Methods

| Improve this Doc View Source

AdjustHighlight()

Declaration
protected override void AdjustHighlight()
Overrides
| Improve this Doc View Source

ForceValue(GeoPoint)

Forces the input object to the specified value. The input filed is updated accordingly.

Declaration
public void ForceValue(GeoPoint p)
Parameters
Type Name Description
GeoPoint p

the point to set

Events

| Improve this Doc View Source

GetGeoPointEvent

This event is used by the display to show the current value of the point. This is necessary if this point is also modified by other means, not only by this input field.

Declaration
public event ConstructAction.GeoPointInput.GetGeoPointDelegate GetGeoPointEvent
Event Type
Type Description
ConstructAction.GeoPointInput.GetGeoPointDelegate
| Improve this Doc View Source

MouseClickEvent

Event that is fired when a mousclick happens and this input has the focus.

Declaration
public event ConstructAction.MouseClickDelegate MouseClickEvent
Event Type
Type Description
ConstructAction.MouseClickDelegate
| Improve this Doc View Source

SetGeoPointEvent

Provide a method for this event to receive the value of the point as it is defined by either keyboard or mouse input.

Declaration
public event ConstructAction.GeoPointInput.SetGeoPointDelegate SetGeoPointEvent
Event Type
Type Description
ConstructAction.GeoPointInput.SetGeoPointDelegate
| Improve this Doc View Source

SetGeoPointExEvent

Provide a method for this event to receive the value of the point as it is defined by either keyboard or mouse input.

Declaration
public event ConstructAction.GeoPointInput.SetGeoPointExDelegate SetGeoPointExEvent
Event Type
Type Description
ConstructAction.GeoPointInput.SetGeoPointExDelegate