Interface IUser
Gives access to the user.
Namespace: TopSolid.Kernel.Automating
Assembly: cs.temp.dll.dll
Syntax
[AvailableSinceVersion(7, 7, 0, 0)]
public interface IUserRemarks
This interface is available since v7.7.
Properties
SelectedEntity
Gets the entity selected by the user.
Declaration
[AvailableSinceVersion(7, 9, 300, 80)]
ElementId SelectedEntity { get; }Property Value
| Type | Description |
|---|---|
| ElementId |
Remarks
If one (and only one) entity is selected by the user, this property returns its identifier, otherwise Empty is returned.
This property is available since v7.9.300.80.
SelectedOperation
Gets the operation selected by the user.
Declaration
[AvailableSinceVersion(7, 9, 300, 80)]
ElementId SelectedOperation { get; }Property Value
| Type | Description |
|---|---|
| ElementId |
Remarks
If one (and only one) operation is selected by the user, this property returns its identifier, otherwise Empty is returned.
This property is available since v7.9.300.80.
Methods
AskAxis3D(UserQuestion, Boolean, SmartAxis3D, out SmartAxis3D)
Asks the user for a 3D axis.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
UserAnswerType AskAxis3D(UserQuestion inQuestion, bool inIsOriented, SmartAxis3D inSuggestion, out SmartAxis3D outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| System.Boolean | inIsOriented | Whether to ask for orientation. |
| SmartAxis3D | inSuggestion | Suggested answer, or |
| SmartAxis3D | outAnswer | User answer, or |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) may be called before calling this method to allow the user to create or modify entities during the interaction.
This method is available since v7.7.
AskDirection3D(UserQuestion, Boolean, SmartDirection3D, out SmartDirection3D)
Asks the user for a 3D direction.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
UserAnswerType AskDirection3D(UserQuestion inQuestion, bool inIsOriented, SmartDirection3D inSuggestion, out SmartDirection3D outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| System.Boolean | inIsOriented | Whether to ask for orientation. |
| SmartDirection3D | inSuggestion | Suggested answer, or |
| SmartDirection3D | outAnswer | User answer, or |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) may be called before calling this method to allow the user to create or modify entities during the interaction.
This method is available since v7.7.
AskEdge(UserQuestion, ElementItemId, out ElementItemId)
Asks the user for an edge.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
UserAnswerType AskEdge(UserQuestion inQuestion, ElementItemId inSuggestion, out ElementItemId outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| ElementItemId | inSuggestion | Suggested answer, or Empty if none. |
| ElementItemId | outAnswer | User answer, or Empty if none. |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
This method is available since v7.7.
AskEdgeList(UserQuestion, List<ElementItemId>, out List<ElementItemId>)
Asks the user for an edge list.
Declaration
[AvailableSinceVersion(7, 13, 0, 0)]
UserAnswerType AskEdgeList(UserQuestion inQuestion, List<ElementItemId> inSuggestions, out List<ElementItemId> outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| List<ElementItemId> | inSuggestions | Suggested answer, or |
| List<ElementItemId> | outAnswer | User answer, or |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
This method is available since v7.13.
AskEdgeWithPickingAxis(UserQuestion, ElementItemId, out ElementItemId, out Axis3D)
Asks the user for an edge with picking axis.
Declaration
[AvailableSinceVersion(7, 10, 300, 60)]
UserAnswerType AskEdgeWithPickingAxis(UserQuestion inQuestion, ElementItemId inSuggestion, out ElementItemId outAnswer, out Axis3D outPickingAxis)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| ElementItemId | inSuggestion | Suggested answer, or Empty if none. |
| ElementItemId | outAnswer | User answer, or Empty if none. |
| Axis3D | outPickingAxis | User picking axis when answer is not empty and not equal to suggestion. |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
This method is available since v7.10.300.60.
AskFace(UserQuestion, ElementItemId, out ElementItemId)
Asks the user for a face.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
UserAnswerType AskFace(UserQuestion inQuestion, ElementItemId inSuggestion, out ElementItemId outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| ElementItemId | inSuggestion | Suggested answer, or Empty if none. |
| ElementItemId | outAnswer | User answer, or Empty if none. |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
This method is available since v7.7.
AskFaceList(UserQuestion, List<ElementItemId>, out List<ElementItemId>)
Asks the user for a face list.
Declaration
[AvailableSinceVersion(7, 13, 0, 0)]
UserAnswerType AskFaceList(UserQuestion inQuestion, List<ElementItemId> inSuggestions, out List<ElementItemId> outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| List<ElementItemId> | inSuggestions | Suggested answer, or |
| List<ElementItemId> | outAnswer | User answer, or |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
This method is available since v7.13.
AskFaceWithPickingAxis(UserQuestion, ElementItemId, out ElementItemId, out Axis3D)
Asks the user for a face with picking axis.
Declaration
[AvailableSinceVersion(7, 10, 300, 60)]
UserAnswerType AskFaceWithPickingAxis(UserQuestion inQuestion, ElementItemId inSuggestion, out ElementItemId outAnswer, out Axis3D outPickingAxis)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| ElementItemId | inSuggestion | Suggested answer, or Empty if none. |
| ElementItemId | outAnswer | User answer, or Empty if none. |
| Axis3D | outPickingAxis | User picking axis when answer is not empty and not equal to suggestion. |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
This method is available since v7.10.300.60.
AskFrame3D(UserQuestion, Boolean, SmartFrame3D, out SmartFrame3D)
Asks the user for a 3D frame.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
UserAnswerType AskFrame3D(UserQuestion inQuestion, bool inIsOriented, SmartFrame3D inSuggestion, out SmartFrame3D outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| System.Boolean | inIsOriented | Whether to ask for orientation. |
| SmartFrame3D | inSuggestion | Suggested answer, or |
| SmartFrame3D | outAnswer | User answer, or |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) may be called before calling this method to allow the user to create or modify entities during the interaction.
This method is available since v7.7.
AskFrame3DList(UserQuestion, List<SmartFrame3D>, out List<SmartFrame3D>)
Asks the user for a 3D frame list.
Declaration
[AvailableSinceVersion(7, 13, 0, 0)]
UserAnswerType AskFrame3DList(UserQuestion inQuestion, List<SmartFrame3D> inSuggestions, out List<SmartFrame3D> outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| List<SmartFrame3D> | inSuggestions | Suggested answer, or |
| List<SmartFrame3D> | outAnswer | User answer, or |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) may be called before calling this method to allow the user to create or modify entities during the interaction.
This method is available since v7.13.
AskInteger(UserQuestion, Int32, Int32, SmartInteger, out SmartInteger)
Asks the user for an integer value.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
UserAnswerType AskInteger(UserQuestion inQuestion, int inMinValue, int inMaxValue, SmartInteger inSuggestion, out SmartInteger outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| System.Int32 | inMinValue | Minimum value. |
| System.Int32 | inMaxValue | Maximum value. |
| SmartInteger | inSuggestion | Suggested answer, or |
| SmartInteger | outAnswer | User answer, or |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) may be called before calling this method to allow the user to create or modify entities during the interaction.
This method is available since v7.7.
AskPlane3D(UserQuestion, Boolean, SmartPlane3D, out SmartPlane3D)
Asks the user for a 3D plane.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
UserAnswerType AskPlane3D(UserQuestion inQuestion, bool inIsOriented, SmartPlane3D inSuggestion, out SmartPlane3D outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| System.Boolean | inIsOriented | Whether to ask for orientation. |
| SmartPlane3D | inSuggestion | Suggested answer, or |
| SmartPlane3D | outAnswer | User answer, or |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) may be called before calling this method to allow the user to create or modify entities during the interaction.
This method is available since v7.7.
AskPoint3D(UserQuestion, SmartPoint3D, out SmartPoint3D)
Asks the user for a 3D point.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
UserAnswerType AskPoint3D(UserQuestion inQuestion, SmartPoint3D inSuggestion, out SmartPoint3D outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| SmartPoint3D | inSuggestion | Suggested answer, or |
| SmartPoint3D | outAnswer | User answer, or |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) may be called before calling this method to allow the user to create or modify entities during the interaction.
This method is available since v7.7.
AskPoint3DList(UserQuestion, List<SmartPoint3D>, out List<SmartPoint3D>)
Asks the user for a 3D point list.
Declaration
[AvailableSinceVersion(7, 13, 0, 0)]
UserAnswerType AskPoint3DList(UserQuestion inQuestion, List<SmartPoint3D> inSuggestions, out List<SmartPoint3D> outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| List<SmartPoint3D> | inSuggestions | Suggested answer, or |
| List<SmartPoint3D> | outAnswer | User answer, or |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) may be called before calling this method to allow the user to create or modify entities during the interaction.
This method is available since v7.13.
AskReal(UserQuestion, UnitType, Double, Double, SmartReal, out SmartReal)
Asks the user for a real value.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
UserAnswerType AskReal(UserQuestion inQuestion, UnitType inUnitType, double inMinValue, double inMaxValue, SmartReal inSuggestion, out SmartReal outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| UnitType | inUnitType | Unit type of the real value. |
| System.Double | inMinValue | Minimum value, in SI unit. |
| System.Double | inMaxValue | Maximum value, in SI unit. |
| SmartReal | inSuggestion | Suggested answer, or |
| SmartReal | outAnswer | User answer, or |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) may be called before calling this method to allow the user to create or modify entities during the interaction.
This method is available since v7.7.
AskShape(UserQuestion, ElementId, out ElementId)
Asks the user for a shape.
Declaration
[AvailableSinceVersion(7, 10, 300, 60)]
UserAnswerType AskShape(UserQuestion inQuestion, ElementId inSuggestion, out ElementId outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| ElementId | inSuggestion | Suggested answer, or Empty if none. |
| ElementId | outAnswer | User answer, or Empty if none. |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
This method is available since v7.10.300.60.
AskShapes(UserQuestion, out List<ElementId>)
Asks the user for shapes.
Declaration
[AvailableSinceVersion(7, 19, 0, 0)]
UserAnswerType AskShapes(UserQuestion inQuestion, out List<ElementId> outAnswer)Parameters
| Type | Name | Description |
|---|---|---|
| UserQuestion | inQuestion | Question asked to the user. |
| List<ElementId> | outAnswer | User answer, or empty list if none. |
Returns
| Type | Description |
|---|---|
| UserAnswerType | Type of user answer. |
Remarks
This method is available since v7.19.000.00.
SelectSelection(ElementId)
Selects a selection entity.
Declaration
[AvailableSinceVersion(7, 16, 0, 0)]
void SelectSelection(ElementId inSelection)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inSelection | The selection entity to select. |