SDK КОМПАС-3D

https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/
Admin
SDK КОМПАС-3D provides a set of development tools for creating applications (such as libraries and...
Tokens:29,682
Snippets:254
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### Getting ParamUMax Property (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iface_paramumax

This snippet shows how to get the final U parameter value using the GetParamUMax() method in Automation syntax for the IFace interface. It assumes 'Object' is a valid IFace instance.

```automation
ParamUMax = Object.GetParamUMax()
```

--------------------------------

### Accessing SnapSettings in COM

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/idocument2dsettings_snapsettings

Shows how to retrieve snap settings using COM syntax. This method is used to get the SnapSettings property, which is read-only.

```COM
Object.get_SnapSettings( &SnapSettings )
```

--------------------------------

### Get DocumentMarking Property (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iadditionalblocktuning_documentmarking

Retrieves the document marking using the COM syntax. This method is part of the IAdditionalBlockTunings interface and requires a pointer to a BSTR for output.

```c++
Object.get_DocumentMarking( &DocumentMarking )
```

--------------------------------

### IAdditionalBlockTunings - DocumentMarking Property

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iadditionalblocktuning_documentmarking

This section details the DocumentMarking property of the IAdditionalBlockTunings interface. It includes methods for getting and setting the document marking in both Automation and COM syntaxes.

```APIDOC
## IAdditionalBlockTunings - DocumentMarking Property

### Description
Provides methods to get and set the document marking for additional block tunings.

### Method
GET/SET

### Endpoint
N/A (Interface Property)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(Not applicable for property access)

### Request Example
(Not applicable for property access)

### Response
#### Success Response (200)
- **DocumentMarking** (BSTR) - The document marking string.

#### Response Example
```json
{
  "DocumentMarking": "ExampleMarking"
}
```

### Syntax
#### Automation Syntax:
- Get: `DocumentMarking = Object.DocumentMarking` or `DocumentMarking = Object.GetDocumentMarking()`
- Set: `Object.DocumentMarking = DocumentMarking` or `Object.SetDocumentMarking( DocumentMarking )`

#### COM Syntax:
- Get: `Object.get_DocumentMarking( &DocumentMarking )`
- Set: `Object.put_DocumentMarking( DocumentMarking )`
```

--------------------------------

### Accessing ParamUMin Property (Automation - Method)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iface_paramumin

Shows an alternative way to get the initial U parameter value using the GetParamUMin() method in Automation. This is another valid approach for retrieving the property's value.

```Automation
ParamUMin = Object.GetParamUMin()
```

--------------------------------

### Get SameSense Property (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iedge_samesense

Retrieves the SameSense property using the COM interface. This property indicates if the direction matches the curve's direction. It is a read-only property.

```COM
Object.get_SameSense( &SameSense )

```

--------------------------------

### Get and Set 'Side' Property (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iextensionsurface_side

Illustrates how to access and change the 'Side' property of an IExtensionSurface object using COM syntax. This involves using get_Side to retrieve the value and put_Side to set it.

```COM
Object.get_Side( &Side ) ' Get property
Object.put_Side( Side ) ' Set property
```

--------------------------------

### Get/Set HatchParametersFromModel (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iassociationview_hatchparametersfrommodel

Illustrates how to get and set the HatchParametersFromModel property using the COM interface. This method is used for interacting with KOMPAS-3D objects via COM, allowing control over associative hatch parameters. It requires an object supporting the IDrawingObject interface.

```csharp
Object.get_HatchParametersFromModel( &HatchParametersFromModel ) | Get property
Object.put_HatchParametersFromModel( HatchParametersFromModel ) | Set property
```

--------------------------------

### Get/Set IsPredefinedTextLibrary Property (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iinsertslibrary_ispredefinedtextlibrary

Demonstrates how to get and set the IsPredefinedTextLibrary property using Automation syntax. This property is a boolean value indicating if the library is used for predefined text insertion.

```Automation
IsPredefinedTextLibrary = Object.IsPredefinedTextLibrary | Получить свойство (* )
Object.IsPredefinedTextLibrary = IsPredefinedTextLibrary | Установить свойство (* )
IsPredefinedTextLibrary = Object.GetIsPredefinedTextLibrary() | Получить свойство (**)
Object.SetIsPredefinedTextLibrary( IsPredefinedTextLibrary ) | Установить свойство (**)
```

--------------------------------

### SheetSetup Method Syntax (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplicationdialogs_sheetsetup

This snippet illustrates the COM syntax for the SheetSetup method. It accepts a parent window handle and an ISheetFormat object, returning an HRESULT for status and a boolean pointer for the result, indicating success or failure.

```COM
HRESULT SheetSetup( OLE_HANDLE ParentHwnd, ISheetFormat * Format, BOOL * Result );
```

--------------------------------

### Get Parametric Mode (Automation Function) - IKompasDocument2D1

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument2d1_parametricmode

Retrieves the parametric mode status of a KOMPAS document using an Automation function. This method is an alternative way to get the boolean status.

```VBScript
ParametricMode = Object.GetParametricMode()
```

--------------------------------

### Get EnableSelectLoadCombination Property (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ichoicemodeldialogparam_enableselectloadcombination

Retrieves the value of the EnableSelectLoadCombination property using COM syntax. This property is used to check if load type selection is permitted for assemblies.

```COM
Object.get_EnableSelectLoadCombination( &EnableSelectLoadCombination )
```

--------------------------------

### SheetSetup Method Syntax (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplicationdialogs_sheetsetup

This snippet shows the syntax for the SheetSetup method when used with the Automation interface. It takes a parent window handle and an ISheetFormat object as input and returns a boolean indicating success or failure.

```Automation
BOOL SheetSetup( OLE_HANDLE ParentHwnd, ISheetFormat * Format );
```

--------------------------------

### Get Object Name by Type (Automation Syntax)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument1_objectnamebytype

Demonstrates how to retrieve an object's name by its type using the Automation syntax for the ObjectNameByType property. This is applicable in environments supporting COM Automation.

```Automation
ObjectNameByType = Object.ObjectNameByType( ObjectType )
```

--------------------------------

### Retrieve ExtensionProgressBar (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplication_extensionprogressbar

This snippet demonstrates the COM syntax for obtaining the ExtensionProgressBar interface. It requires Header, Description, and a reference to ExtensionProgressBar to be passed.

```COM
Object.get_ExtensionProgressBar( Header, Description, &ExtensionProgressBar )
```

--------------------------------

### Get Height Property - Automation Syntax

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/idimensiontext_height

Demonstrates how to retrieve the Height property of a dimension text object using Automation syntax. This method is used to get the height of the dimension text in millimeters. It assumes the existence of an 'Object' variable representing the dimension text.

```Automation
Height = Object.Height
' Get property(* )
```

```Automation
Height = Object.GetHeight()
' Get property(**)
```

--------------------------------

### Get Periodic Property (COM Syntax)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/icurve2d_periodic

Retrieves the periodicity of a curve using the COM interface. This is a read-only property.

```COM
Object.get_Periodic( &Periodic )
```

--------------------------------

### ChoiceQuality Method Syntax (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplicationdialogs_choicequality

This snippet shows the Automation syntax for the ChoiceQuality method. It defines the return type and parameters, including the owner window handle, current quality class, and size value.

```Automation
BSTR ChoiceQuality( OLE_HANDLE HWnd, BSTR CurrentQuality, double Value );
```

--------------------------------

### Get Periodic Property (Automation Syntax)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/icurve2d_periodic

Retrieves the periodicity of a curve using the Automation interface. This is a read-only property.

```Automation
Periodic = Object.Periodic
Object.GetPeriodic()
```

--------------------------------

### ChoiceFolder Method Syntax (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplicationdialogs_choicefolder

This snippet shows the COM syntax for the ChoiceFolder method. It takes a window handle and an initial path as input and returns an HRESULT status along with the selected directory path.

```COM
HRESULT ChoiceFolder( OLE_HANDLE HWnd, BSTR InitialPath, BSTR * Result );
```

--------------------------------

### Get ParamVMax Property (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iface_paramvmax

Retrieves the final V parameter value of an IFace object using the COM syntax. This is a read-only property.

```COM
Object.get_ParamVMax( &ParamVMax )
```

--------------------------------

### IConeByAngle Interface

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iconebyangle

Documentation for the IConeByAngle interface, used to create cones with specified base center, diameters, and angle.

```APIDOC
## IConeByAngle Interface

### Description
Interface for creating a cone using the center of the base, diameters, and angle.

### Hierarchy
IDispatch
IKompasAPIObject
IModelObject
IElemntaryBody
IConeByAngle

### Notes
This interface can be obtained using the `IElemntaryBodies::ElementaryBody` property or the `IElemntaryBodies::Add` method.

### Available in
KOMPAS v24

### Related Subsections
- IConeByAngle - Properties
- IConeByArcs Interface
```

--------------------------------

### Get ParamVMax Property (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iface_paramvmax

Retrieves the final V parameter value of an IFace object using the Automation syntax. This is a read-only property.

```Automation
ParamVMax = Object.ParamVMax
```

--------------------------------

### Rebuild View Method - Automation and COM Syntax

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iassociationview_rebuild

Demonstrates the syntax for the Rebuild method of the IView interface in KOMPAS-3D SDK. It includes the Automation syntax returning a boolean and the COM syntax returning an HRESULT. This method is used to rebuild the view.

```automation
BOOL Rebuild();
```

```com
HRESULT Rebuild( BOOL * Result );
```

--------------------------------

### Получение ParamVMin (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iface_paramvmin

Получает начальное значение параметра V для объекта IFace, используя синтаксис Automation. Это свойство доступно только для чтения.

```Automation
ParamVMin = Object.ParamVMin
```

```Automation
ParamVMin = Object.GetParamVMin()
```

--------------------------------

### Get TreeNeedRebuild Property (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument2d1_reeneedrebuild

Retrieves the value of the TreeNeedRebuild property using the COM interface. This function is used to check if the tree structure needs to be rebuilt.

```COM
Object.get_TreeNeedRebuild( &TreeNeedRebuild ) | Получить свойство
```

--------------------------------

### ChoiceFolder Method Syntax (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplicationdialogs_choicefolder

This snippet shows the Automation syntax for the ChoiceFolder method. It takes a window handle and an initial path as input and returns the selected directory path.

```Automation
BSTR ChoiceFolder( OLE_HANDLE HWnd, BSTR InitialPath );
```

--------------------------------

### Automation Syntax for HideMeshes Property

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument3d1_hidemeshes

Demonstrates how to get and set the HideMeshes property using Automation syntax. This property is of type BOOL and controls the visibility of polygonal objects.

```Automation
HideMeshes = Object.HideMeshes
Object.HideMeshes = HideMeshes
HideMeshes = Object.GetHideMeshes()
Object.SetHideMeshes( HideMeshes )
```

--------------------------------

### Get TreeNeedRebuild Property (Automation - Method)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument2d1_reeneedrebuild

Retrieves the value of the TreeNeedRebuild property using the GetTreeNeedRebuild method in Automation. This is an alternative way to check if a tree rebuild is necessary.

```Automation
TreeNeedRebuild = Object.GetTreeNeedRebuild() | Получить свойство (**)
```

--------------------------------

### InitCutObjects Method Syntax (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/icut_initcutobjects

This snippet shows the COM syntax for the InitCutObjects method. It is used to set the cutting objects for an operation. The method returns an HRESULT and a boolean value indicating success or failure.

```cpp
HRESULT InitCutObjects( VARIANT CutObjects, BOOL TangentObjects, BOOL * Result );
```

--------------------------------

### IParts7::AddFromFileWithParam

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/new_methods_v24

Adds an existing component from a file or model library to a document with specified parameters.

```APIDOC
## IParts7::AddFromFileWithParam

### Description
Adds an existing component from a file or model library to the document and collection with specified parameters.

### Method
POST (Assumed, as it adds data)

### Endpoint
`/parts7/addfromfilewithparam`

### Parameters
#### Request Body
- **filePath** (string) - Required - Path to the component file or library.
- **parameters** (object) - Optional - Parameters for adding the component.

### Response
#### Success Response (200)
- **componentId** (string) - The ID of the added component.

#### Response Example
```json
{
  "componentId": "comp456def"
}
```
```

--------------------------------

### Get TreeNeedRebuild Property (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument2d1_reeneedrebuild

Retrieves the value of the TreeNeedRebuild property using the Automation interface. This property indicates if the tree structure requires rebuilding due to changes.

```Automation
TreeNeedRebuild = Object.TreeNeedRebuild | Получить свойство (* )
```

--------------------------------

### ChoiceQuality Method Syntax (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplicationdialogs_choicequality

This snippet presents the COM syntax for the ChoiceQuality method. It specifies the HRESULT return type and the parameters, including an output parameter for the result.

```COM
HRESULT ChoiceQuality( OLE_HANDLE HWnd, BSTR CurrentQuality, double Value, BSTR * Result );
```

--------------------------------

### Get TreeNeedUpdateItems Property (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument2d1_treeneedupdateitems

Retrieves the value of the TreeNeedUpdateItems property using the COM interface. This is used to check if the document's tree nodes require an update.

```csharp
Object.get_TreeNeedUpdateItems( &TreeNeedUpdateItems );
```

--------------------------------

### Get OrderNumber Property (Automation) - KOMPAS SDK

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ifeature7_ordernumber

Retrieves the sequential order number of a feature using the Automation syntax. This is a read-only property.

```Automation
OrderNumber = Object.OrderNumber
```

--------------------------------

### InitCutObjects Method Syntax (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/icut_initcutobjects

This snippet shows the Automation syntax for the InitCutObjects method. It is used to set the cutting objects for an operation. The method returns a boolean value indicating success or failure.

```cpp
BOOL InitCutObjects( VARIANT CutObjects, BOOL TangentObjects );
```

--------------------------------

### IBlockBySizes Interface

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iblockbysizes

Documentation for the IBlockBySizes interface, which defines how to create a parallelepiped by specifying a point and three dimensions.

```APIDOC
## IBlockBySizes Interface

### Description
Interface for creating a parallelepiped using a point and three dimensions.

### Method
N/A (Interface definition)

### Endpoint
N/A (Interface definition)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

### Hierarchy
IDispatch
IKompasAPIObject
IModelObject
IElementaryBody
IBlockBySizes

### Notes
This interface can be obtained using the IElementaryBodies::ElementaryBody property or the IElementaryBodies::Add method.

### Version
KOMPAS v24

### Related Subsections
- IBlockBySizes - properties
```

--------------------------------

### IConeByHeight Interface

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iconebyheight

Documentation for the IConeByHeight interface, which defines methods and properties for creating and manipulating cone objects in KOMPAS-3D.

```APIDOC
## IConeByHeight Interface

### Description
Interface for creating a cone by the center of the base, diameters, and height.

### Method
Not applicable (Interface definition)

### Endpoint
Not applicable (Interface definition)

### Parameters
This interface is obtained using the `IElementaryBodies::ElementaryBody` property or the `IElementaryBodies::Add` method.

### Request Example
Not applicable (Interface definition)

### Response
#### Success Response (200)
This interface provides properties and methods for cone manipulation.

#### Response Example
Not applicable (Interface definition)

### Hierarchy
IDispatch
IKompasAPIObject
IModelObject
IElementaryBody
IConeByHeight

### Notes
The interface can be obtained using the `IElementaryBodies::ElementaryBody` property or the `IElementaryBodies::Add` method.

### Version
KOMPAS v24
```

--------------------------------

### Get DocumentMarking Property (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iadditionalblocktuning_documentmarking

Retrieves the document marking using the Automation syntax. This method is part of the IAdditionalBlockTunings interface and returns a BSTR type.

```vba
DocumentMarking = Object.GetDocumentMarking()
```

--------------------------------

### Retrieve ExtensionProgressBar (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplication_extensionprogressbar

This snippet shows the Automation syntax for retrieving the ExtensionProgressBar, which is an interface to a progress bar indicator. It takes Header and Description as arguments.

```Automation
ExtensionProgressBar = Object.ExtensionProgressBar( Header, Description )
ExtensionProgressBar = Object.GetExtensionProgressBar( Header, Description )
```

--------------------------------

### SurfaceOperationResult Data Type

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iextensionsurface_surfaceoperationresult

Details on the SurfaceOperationResult data type, including its enumeration, syntax for Automation and COM, and available operations for getting and setting its value.

```APIDOC
## SurfaceOperationResult Data Type

### Description
This section describes the `SurfaceOperationResult` data type, which is an enumeration representing the result of a surface operation within the KOMPAS-3D SDK. It details how to interact with this data type using both Automation and COM syntaxes.

### Data Type
`SurfaceOperationResult` (Enumeration)

### Syntax
#### Automation
- **Get Property:** `SurfaceOperationResult = Object.SurfaceOperationResult | Get Property (*)`
- **Set Property:** `Object.SurfaceOperationResult = SurfaceOperationResult | Set Property (*)`
- **Get Method:** `SurfaceOperationResult = Object.GetSurfaceOperationResult() | Get Property (**)`
- **Set Method:** `Object.SetSurfaceOperationResult( SurfaceOperationResult ) | Set Property (**)`

#### COM
- **Get Property:** `Object.get_SurfaceOperationResult( &SurfaceOperationResult ) | Get Property`
- **Set Property:** `Object.put_SurfaceOperationResult( SurfaceOperationResult ) | Set Property`

### Parameters
- **SurfaceOperationResult**: The value of the surface operation result. (Type: `ksSurfaceOperationResultEnum`)

### Response
#### Success Response
- **SurfaceOperationResult** (ksSurfaceOperationResultEnum) - The result of the surface operation.
```

--------------------------------

### Получение ParamVMin (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iface_paramvmin

Получает начальное значение параметра V для объекта IFace, используя синтаксис COM. Это свойство доступно только для чтения.

```COM
Object.get_ParamVMin( &ParamVMin )
```

--------------------------------

### Get SameSense Property (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iedge_samesense

Retrieves the SameSense property using the Automation interface. This property indicates if the direction matches the curve's direction. It is a read-only property.

```Automation
SameSense = Object.SameSense

```

```Automation
SameSense = Object.GetSameSense()

```

--------------------------------

### GetPoint Method Syntax for IFace (KOMPAS-3D SDK)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iface_getpoint

This snippet shows the syntax for the GetPoint method of the IFace interface in KOMPAS-3D SDK. It includes variations for Automation and COM, specifying input parameters for parametric coordinates and output parameters for spatial coordinates.

```Automation
BOOL GetPoint( double ParamU, double ParamV, double * X, double * Y, double * Z );
```

```COM
HRESULT GetPoint( double ParamU, double ParamV, double * X, double * Y, double * Z, BOOL * Result );
```

--------------------------------

### Accessing ParamUMin Property (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iface_paramumin

Illustrates how to obtain the initial U parameter value using the COM syntax. This method requires passing a variable to the get_ParamUMin function to receive the property's value.

```COM
Object.get_ParamUMin( &ParamUMin )
```

--------------------------------

### Get LightObjectType Property (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/idrawingobject1_lightobjecttype

Retrieves the lighting type of a 2D drawing object using the Automation interface. This method is part of the IDrawingObject1 interface.

```Automation
LightObjectType = Object.LightObjectType
LightObjectType = Object.GetLightObjectType()
```

--------------------------------

### Get AutoBuilding Property (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/autobuilding_autobuilding

Retrieves the AutoBuilding property value using the COM interface. This method is specific to COM interactions with the KOMPAS-3D SDK.

```csharp
Object.get_AutoBuilding( &AutoBuilding ) | Получить свойство
```

--------------------------------

### NearPointProjection Method - COM Syntax

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iface_nearpointprojection

This snippet illustrates the syntax for the NearPointProjection method via the COM interface. It includes a BOOL * Result parameter to indicate success or failure.

```COM
HRESULT NearPointProjection( double X, double Y, double Z, double * ParamU, double * ParamV, BOOL * Result );
```

--------------------------------

### IProcess2D::GetSnapPoint

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/new_methods_v24

Retrieves a snap point in a 2D process.

```APIDOC
## IProcess2D::GetSnapPoint

### Description
Gets a snap point within a 2D process.

### Method
GET (Assumed, as it retrieves data)

### Endpoint
`/process2d/getsnappoint`

### Parameters
#### Query Parameters
- **processId** (string) - Required - The ID of the 2D process.
- **snapType** (string) - Optional - The type of snap point to retrieve.

### Response
#### Success Response (200)
- **snapPoint** (Point2D) - The coordinates of the snap point.

#### Response Example
```json
{
  "snapPoint": {
    "x": 100,
    "y": 200
  }
}
```
```

--------------------------------

### IText::InsertPredefinedText

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/new_methods_v24

Retrieves predefined text from a *.kle file.

```APIDOC
## IText::InsertPredefinedText

### Description
Retrieves predefined text from a *.kle file.

### Method
GET (Assumed, as it retrieves data)

### Endpoint
`/text/insertpredefinedtext`

### Parameters
#### Query Parameters
- **filePath** (string) - Required - The path to the *.kle file.
- **textKey** (string) - Required - The key identifying the predefined text.

### Response
#### Success Response (200)
- **predefinedText** (string) - The retrieved predefined text.

#### Response Example
```json
{
  "predefinedText": "This is some predefined text."
}
```
```

--------------------------------

### Get HideTables Property (Automation) | KOMPAS-3D SDK

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument3d1_hidetables

Retrieves the current state of the HideTables property using Automation syntax. This method is part of the IKompasDocument3D1 interface.

```Automation
HideTables = Object.GetHideTables()
```

--------------------------------

### ISystemSettings::GetChoiceModelParam

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/new_methods_v24

Retrieves additional parameters for model file selection.

```APIDOC
## ISystemSettings::GetChoiceModelParam

### Description
Gets additional parameters for model file selection.

### Method
GET (Assumed, as it retrieves data)

### Endpoint
`/systemsettings/getchoicemodelparam`

### Parameters
(No specific parameters mentioned, assumes global settings)

### Response
#### Success Response (200)
- **modelParams** (object) - An object containing parameters related to model file selection.

#### Response Example
```json
{
  "modelParams": {
    "filter": "*.m3d",
    "defaultPath": "/models"
  }
}
```
```

--------------------------------

### SplitIntoFaces Property - Automation Syntax

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iextensionsurface_splitintofaces

Demonstrates how to get and set the SplitIntoFaces property using the Automation interface. This property is of type BOOL and is used to determine if a surface should be split into faces.

```automation
SplitIntoFaces = Object.SplitIntoFaces | Получить свойство (* )
Object.SplitIntoFaces = SplitIntoFaces | Установить свойство (* )
SplitIntoFaces = Object.GetSplitIntoFaces() | Получить свойство (**)
Object.SetSplitIntoFaces( SplitIntoFaces ) | Установить свойство (**)
```

--------------------------------

### IApplicationDialogs - SelectColor Method

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplicationdialogs_selectcolor

The SelectColor method allows for the selection of a color within the KOMPAS-3D application. It is available via Automation and COM interfaces.

```APIDOC
## SelectColor - Color Selection

### Description
Allows the user to select a color. This method is part of the IApplicationDialogs interface.

### Method
Automation: BOOL SelectColor( OLE_HANDLE HWnd, BSTR Caption, long * Color );
COM: HRESULT SelectColor( OLE_HANDLE HWnd, BSTR Caption, long * Color, BOOL * Result );

### Endpoint
N/A (This is a method call within the SDK)

### Parameters
#### Input Parameters
- **HWnd** (OLE_HANDLE) - Handle of the owner window.
- **Caption** (BSTR) - The title of the color selection dialog.
- **Color** (long *) - Pointer to a long integer that will store the selected color value.
- **Result** (BOOL *) - (COM only) Pointer to a boolean indicating the success of the operation.

### Response
#### Success Response
- **Return Value** (BOOL/HRESULT) - TRUE (Automation) or S_OK (COM) in case of successful completion.
- **Return Value** (BOOL/HRESULT) - FALSE (Automation) or a failure code (COM) in case of failure.

#### Response Example
(No direct response example, as it's a method call that modifies parameters and returns a status.)
```

--------------------------------

### IChoiceModelParam Interface

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ichoicemodelparam

Documentation for the IChoiceModelParam interface, which is part of the KOMPAS-3D SDK. This interface is related to model selection parameters and is an addition to ISystemSettings.

```APIDOC
## Interface IChoiceModelParam

### Description
Interface for model selection parameters. This interface is supplementary to ISystemSettings.

### Hierarchy
IDispatch
IChoiceModelParam

### Version
KOMPAS v24

### Subsections
- IChoiceModelParam - Properties
- IChoiceModelParam - Methods

### Note
This interface is an addition to ISystemSettings.
```

--------------------------------

### Get OrderNumber Method (Automation) - KOMPAS SDK

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ifeature7_ordernumber

Retrieves the sequential order number of a feature using the GetOrderNumber method in Automation syntax. This is a read-only property.

```Automation
OrderNumber = Object.GetOrderNumber()
```

--------------------------------

### Get EnableSelectLoadCombination Property (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ichoicemodeldialogparam_enableselectloadcombination

Retrieves the value of the EnableSelectLoadCombination property using Automation syntax. This property determines if load type selection is allowed for assemblies.

```Automation
EnableSelectLoadCombination = Object.EnableSelectLoadCombination
EnableSelectLoadCombination = Object.GetEnableSelectLoadCombination()
```

--------------------------------

### NearPointProjection Method - Automation Syntax

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iface_nearpointprojection

This snippet shows the syntax for the NearPointProjection method using the Automation interface. It takes point coordinates as input and returns parametric coordinates.

```Automation
BOOL NearPointProjection( double X, double Y, double Z, double * ParamU, double * ParamV );
```

--------------------------------

### IParts7::AddWithParam

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/new_methods_v24

Creates a new insertion in an assembly context with specified parameters.

```APIDOC
## IParts7::AddWithParam

### Description
Creates a new insertion in the context of an assembly with specified parameters.

### Method
POST (Assumed, as it creates data)

### Endpoint
`/parts7/addwithparam`

### Parameters
#### Request Body
- **assemblyId** (string) - Required - The ID of the assembly.
- **parameters** (object) - Required - Parameters for the new insertion.

### Response
#### Success Response (200)
- **insertionId** (string) - The ID of the created insertion.

#### Response Example
```json
{
  "insertionId": "ins789ghi"
}
```
```

--------------------------------

### ApexCurve Property Access (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iconicsurface_apexcurve

Demonstrates how to get and set the ApexCurve property using Automation syntax. This involves direct property access or using Get/Set methods.

```vba
ApexCurve = Object.ApexCurve ' Get property
Object.ApexCurve = ApexCurve ' Set property

ApexCurve = Object.GetApexCurve() ' Get property
Object.SetApexCurve( ApexCurve ) ' Set property
```

--------------------------------

### Get Selection Area Objects (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument2d1_viewgetobjectsarea

Retrieves a group of graphical objects defining a selection area using a visual process via Automation. This method returns an LPDISPATCH representing the IDrawingGroup.

```Automation
LPDISPATCH ViewGetObjectsArea();
```

--------------------------------

### RebuildViews Method Syntax (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/idrawingdocument_rebuildviews

This snippet shows the Automation syntax for the RebuildViews method. It takes a VARIANT 'Views' as input and returns a BOOL indicating success or failure.

```Automation
BOOL RebuildViews( VARIANT Views );
```

--------------------------------

### Get/Set OrthogonalMode (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument2d1_orthogonalmode

Illustrates how to get and set the OrthogonalMode property using the COM interface. This method is used for interacting with KOMPAS-3D objects via COM, managing the orthogonal drawing setting.

```COM
Object.get_OrthogonalMode( &OrthogonalMode )
Object.put_OrthogonalMode( OrthogonalMode )
```

--------------------------------

### PlaceFeaturesInto Method Syntax (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument3d1_placefeaturesinto

This snippet shows the COM syntax for the PlaceFeaturesInto method. It takes a VARIANT containing the features to move and an IFeature7 pointer representing the target feature. It returns an HRESULT and a BOOL pointer for the operation's success.

```COM
HRESULT PlaceFeaturesInto( VARIANT MoveFeatures, IFeature7 * IntoFeature, BOOL * Result );
```

--------------------------------

### GetPredefinedText Method Syntax (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplicationdialogs_getpredefinedtext

This snippet shows the Automation syntax for the GetPredefinedText method. It is used to retrieve predefined text from a specified library file.

```Automation
BSTR GetPredefinedText( OLE_HANDLE HWnd, BSTR Caption, BSTR PredefinedTextLibrary );
```

--------------------------------

### GetPredefinedText Method Syntax (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplicationdialogs_getpredefinedtext

This snippet illustrates the COM syntax for the GetPredefinedText method. It returns a HRESULT and the retrieved text via a BSTR pointer.

```COM
HRESULT GetPredefinedText( OLE_HANDLE HWnd, BSTR Caption, BSTR PredefinedTextLibrary, BSTR * Result );
```

--------------------------------

### Get Parametric Mode (COM) - IKompasDocument2D1

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument2d1_parametricmode

Retrieves the parametric mode of a KOMPAS document using COM syntax. This involves passing a variable to receive the boolean output.

```C++
Object.get_ParametricMode( &ParametricMode )
```

--------------------------------

### Get LightObjectType Property (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/idrawingobject1_lightobjecttype

Accesses the lighting type of a 2D drawing object using the COM interface. This function is provided by the IDrawingObject1 interface for COM-based interactions.

```COM
Object.get_LightObjectType( &LightObjectType )
```

--------------------------------

### ICut - InitCutObjects Method

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/icut_initcutobjects

Initializes the cutting objects for the ICut interface. This method allows you to specify which sketches and surfaces should be used for cutting operations, and whether to include tangent objects.

```APIDOC
## ICut - InitCutObjects

### Description
Sets the cutting objects (sketches and surfaces) and optionally includes tangent objects for the cutting operation.

### Method
Automation: BOOL InitCutObjects( VARIANT CutObjects, BOOL TangentObjects );
COM: HRESULT InitCutObjects( VARIANT CutObjects, BOOL TangentObjects, BOOL * Result );

### Endpoint
(Not applicable for SDK methods)

### Parameters
#### Input Parameters
- **CutObjects** (VARIANT) - Required - A list of cutting objects (sketches and surfaces).
- **TangentObjects** (BOOL) - Required - Specifies whether to include tangent objects. TRUE to include, FALSE otherwise.

### Request Example
(Not applicable for SDK methods)

### Response
#### Success Response
- **Result** (BOOL) - TRUE if the operation was successful, FALSE otherwise.

#### Response Example
(Not applicable for SDK methods)
```

--------------------------------

### RebuildViews Method Syntax (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/idrawingdocument_rebuildviews

This snippet shows the COM syntax for the RebuildViews method. It takes a VARIANT 'Views' and a pointer to a BOOL 'Result' as input, returning an HRESULT status code.

```COM
HRESULT RebuildViews( VARIANT Views, BOOL * Result );
```

--------------------------------

### Get AutoBuilding Property (Automation Function)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/autobuilding_autobuilding

Retrieves the AutoBuilding property value using a dedicated Automation function. This is an alternative method for accessing properties in the KOMPAS-3D SDK.

```javascript
AutoBuilding = Object.GetAutoBuilding() | Получить свойство (**)
```

--------------------------------

### CopyToDocument Method Syntax (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/idrawinggroup_copytodocument

This snippet shows the Automation syntax for the CopyToDocument method of the IDrawingGroup interface. It takes a pointer to an IKompasDocument2D as input and returns an LPDISPATCH representing the newly created IDrawingGroup.

```cpp
LPDISPATCH CopyToDocument( IKompasDocument2D * OtherDocument );
```

--------------------------------

### Get AutoBuilding Property (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/autobuilding_autobuilding

Retrieves the AutoBuilding property value using the Automation interface. This method is part of the KOMPAS-3D SDK for interacting with 3D document surfaces.

```javascript
AutoBuilding = Object.AutoBuilding | Получить свойство (* )
```

--------------------------------

### SelectColor Method Syntax (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplicationdialogs_selectcolor

This snippet shows the COM syntax for the SelectColor method. It is used for color selection and returns an HRESULT for status, along with a boolean for the operation's result.

```COM
HRESULT SelectColor( OLE_HANDLE HWnd, BSTR Caption, long * Color, BOOL * Result );
```

--------------------------------

### Get HideTables Property (COM) | KOMPAS-3D SDK

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument3d1_hidetables

Retrieves the current state of the HideTables property using COM syntax. This method is provided by the IKompasDocument3D1 interface for COM interactions.

```COM
Object.get_HideTables( &HideTables )
```

--------------------------------

### CheckAssociation Method Syntax (Automation and COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument2d1_checkassociation

This snippet shows the syntax for the CheckAssociation method in both Automation and COM interfaces. It details the parameters and return types, which are crucial for interacting with KOMPAS-3D's document objects.

```automation
ksCheckAssociationResultEnum CheckAssociation( VARIANT DimensionTypes, ksCheckObjectsTypeEnum CheckType, VARIANT CheckStyle, long * CompleteAssocCount, long * IncompleteAssocCount );
```

```com
HRESULT CheckAssociation( VARIANT DimensionTypes, ksCheckObjectsTypeEnum CheckType, VARIANT CheckStyle, long * CompleteAssocCount, long * IncompleteAssocCount, ksCheckAssociationResultEnum * Result );
```

--------------------------------

### Get Selection Area Objects (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument2d1_viewgetobjectsarea

Retrieves a group of graphical objects defining a selection area using a visual process via COM. This method returns an HRESULT and populates an IDrawingGroup pointer with the result.

```C++
HRESULT ViewGetObjectsArea( IDrawingGroup * * Result );
```

--------------------------------

### Interface IConeByArcs

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iconebyarcs

Documentation for the IConeByArcs interface, which defines a cone created by two arcs. It details the interface's hierarchy, properties, and methods for adding or retrieving elementary bodies.

```APIDOC
## Interface IConeByArcs

### Description
This interface represents a cone defined by two arcs. It is part of the KOMPAS-3D SDK and allows for the creation and manipulation of elementary 3D bodies.

### Method
N/A (Interface Definition)

### Endpoint
N/A (Interface Definition)

### Parameters
N/A (Interface Definition)

### Request Example
N/A (Interface Definition)

### Response
#### Success Response (N/A)
N/A (Interface Definition)

#### Response Example
N/A (Interface Definition)

### Hierarchy
- IDispatch
- IKompasAPIObject
- IModelObject
- IElementaryBody
- IConeByArcs

### Notes
This interface can be obtained using the `IElementaryBodies::ElementaryBody` property or the `IElementaryBodies::Add` method.

### Related Subsections
- IConeByArcs - Properties
```

--------------------------------

### ParametrizeObjects Method Syntax (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument2d1_parametrizeobjects

This snippet shows the Automation syntax for the ParametrizeObjects method. It takes a VARIANT of objects and an IParametrizationParam7 pointer as input. The method returns a BOOL indicating success or failure.

```Automation
BOOL ParametrizeObjects( VARIANT Objects, IParametrizationParam7 * Param );
```

--------------------------------

### Get TreeNeedUpdateItems Property (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument2d1_treeneedupdateitems

Retrieves the value of the TreeNeedUpdateItems property using the Automation interface. This property indicates whether the tree nodes need updating due to changes in document object properties or states.

```automation
TreeNeedUpdateItems = Object.TreeNeedUpdateItems
' or
TreeNeedUpdateItems = Object.GetTreeNeedUpdateItems()
```

--------------------------------

### Check if Construction Process is Running (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument1_isactiveprocessrunning

This code snippet illustrates how to check if a construction process is running using the get_IsActiveProcessRunning() method in COM syntax. It retrieves the boolean value into a variable.

```COM
Object.get_IsActiveProcessRunning( &IsActiveProcessRunning )
```

--------------------------------

### Get OrderNumber Property (COM) - KOMPAS SDK

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ifeature7_ordernumber

Retrieves the sequential order number of a feature using the COM syntax. This is a read-only property and requires passing a variable to receive the value.

```COM
Object.get_OrderNumber( &OrderNumber )
```

--------------------------------

### IApplicationDialogs - GetPredefinedText

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplicationdialogs_getpredefinedtext

Retrieves predefined text from a specified library file. This method is available through both Automation and COM interfaces.

```APIDOC
## POST /api/application/dialogs/predefinedtext

### Description
Retrieves predefined text from a specified library file using the GetPredefinedText method.

### Method
POST

### Endpoint
/api/application/dialogs/predefinedtext

### Parameters
#### Request Body
- **HWnd** (integer) - Required - Handle to the owner window.
- **Caption** (string) - Required - The caption for the dialog.
- **PredefinedTextLibrary** (string) - Required - The path to the predefined text library file (*.kle).

### Request Example
```json
{
  "HWnd": 12345,
  "Caption": "Select Text",
  "PredefinedTextLibrary": "C:\\KOMPAS-3D\\TextLibraries\\MyLibrary.kle"
}
```

### Response
#### Success Response (200)
- **Result** (string) - The predefined text retrieved from the library.
```

--------------------------------

### PlaceFeaturesInto Method Syntax (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument3d1_placefeaturesinto

This snippet shows the Automation syntax for the PlaceFeaturesInto method. It takes a VARIANT containing the features to move and an IFeature7 pointer representing the target feature. It returns a BOOL indicating success or failure.

```Automation
BOOL PlaceFeaturesInto( VARIANT MoveFeatures, IFeature7 * IntoFeature );
```

--------------------------------

### SurfaceOperationResult Property Access (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iextensionsurface_surfaceoperationresult

Demonstrates how to get and set the SurfaceOperationResult property using the Automation interface in KOMPAS-3D SDK. This involves direct property access or using dedicated get/set methods.

```Automation
SurfaceOperationResult = Object.SurfaceOperationResult
Object.SurfaceOperationResult = SurfaceOperationResult
SurfaceOperationResult = Object.GetSurfaceOperationResult()
Object.SetSurfaceOperationResult( SurfaceOperationResult )
```

--------------------------------

### Rebuild Method

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iassociationview_rebuild

The Rebuild method is used to rebuild a view within the KOMPAS-3D environment. It is available through both Automation and COM syntaxes.

```APIDOC
## Rebuild Method

### Description
Rebuilds a view within the KOMPAS-3D environment.

### Method
Automation: BOOL Rebuild();
COM: HRESULT Rebuild( BOOL * Result );

### Endpoint
N/A (This is a method within an interface, not a REST endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
Automation:
```javascript
view.Rebuild();
```

COM:
```javascript
VARIANT Result;
HRESULT hr = pView->Rebuild(&Result);
```

### Response
#### Success Response (200)
- **Result** (BOOL) - TRUE if the rebuild was successful, FALSE otherwise.

#### Response Example
Automation:
```javascript
// Returns TRUE or FALSE
let success = view.Rebuild();
```

COM:
```javascript
// Result will contain TRUE or FALSE
```
```

--------------------------------

### SelectColor Method Syntax (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplicationdialogs_selectcolor

This snippet shows the Automation syntax for the SelectColor method. It is used to select a color and returns a boolean indicating success or failure.

```Automation
BOOL SelectColor( OLE_HANDLE HWnd, BSTR Caption, long * Color );
```

--------------------------------

### Get Dimension Text Width (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/idimensiontext_width

Retrieves the width of a dimension text using the Automation interface. This property is read-only and returns the width in millimeters. It requires an object representing the dimension text.

```Automation
Width = Object.Width
' or
Width = Object.GetWidth()
```

--------------------------------

### CopyToDocument Method Syntax (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/idrawinggroup_copytodocument

This snippet shows the COM syntax for the CopyToDocument method of the IDrawingGroup interface. It takes a pointer to an IKompasDocument2D and a pointer to an IDrawingGroup (for the result) as input. It returns an HRESULT indicating success or failure.

```cpp
HRESULT CopyToDocument( IKompasDocument2D * OtherDocument, IDrawingGroup * * Result );
```

--------------------------------

### Get CutObjects Property (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/icut_cutobjects

Retrieves the CutObjects property using the COM interface. This method is used to access the cutting objects (sketches and surfaces) associated with an operation. It requires a pointer to store the retrieved CutObjects.

```COM
Object.get_CutObjects( &CutObjects )
```

--------------------------------

### IInsertPartParameters Interface

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iinsertpartparameters

This section describes the IInsertPartParameters interface, which is used for defining parameters when inserting a model into an assembly in KOMPAS-3D.

```APIDOC
## IInsertPartParameters Interface

### Description
Interface for parameters of inserting a model into an assembly. This interface needs to be obtained using the IKompasDocument1::GetInterface method with the ksObjectInsertPartParameters constant.

### Hierarchy
IDispatch
IKompasAPIObject
IInsertPartParameters

### Version
KOMPAS v24

### Subsections
- IInsertPartParameters - properties
- IInsertPartParameters - methods
```

--------------------------------

### Get Parametric Mode (Automation) - IKompasDocument2D1

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument2d1_parametricmode

Retrieves the parametric mode status of a KOMPAS document using Automation syntax. This property returns a boolean value indicating whether the document is in parametric mode.

```VBScript
ParametricMode = Object.ParametricMode
```

--------------------------------

### IApplicationDialogs - ChoiceQuality Method

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iapplicationdialogs_choicequality

The ChoiceQuality method, available through the IApplicationDialogs interface, allows for the selection of a tolerance class. It is accessible via both Automation and COM syntaxes.

```APIDOC
## POST /api/kompas/iApplicationDialogs/choiceQuality

### Description
This endpoint represents the ChoiceQuality method of the IApplicationDialogs interface in the KOMPAS-3D SDK. It facilitates the selection of a tolerance class based on provided parameters.

### Method
POST

### Endpoint
/api/kompas/iApplicationDialogs/choiceQuality

### Parameters
#### Request Body
- **HWnd** (OLE_HANDLE) - Required - The handle of the owner window.
- **CurrentQuality** (BSTR) - Required - The current tolerance class.
- **Value** (double) - Required - The size value.

### Request Example
```json
{
  "HWnd": 12345,
  "CurrentQuality": "Class A",
  "Value": 10.5
}
```

### Response
#### Success Response (200)
- **Result** (BSTR) - Description: The selected tolerance class. (For COM syntax)

#### Response Example
```json
{
  "Result": "Class B"
}
```

### Notes
- **Automation Syntax:** `BSTR ChoiceQuality( OLE_HANDLE HWnd, BSTR CurrentQuality, double Value );`
- **COM Syntax:** `HRESULT ChoiceQuality( OLE_HANDLE HWnd, BSTR CurrentQuality, double Value, BSTR * Result );`
```

--------------------------------

### Get Object Name by Type (COM Syntax)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument1_objectnamebytype

Illustrates retrieving an object's name by its type using the COM syntax for the ObjectNameByType property. This method is used in traditional COM programming contexts.

```COM
Object.get_ObjectNameByType( ObjectType, &ObjectNameByType )
```

--------------------------------

### Accessing ParamUMin Property (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iface_paramumin

Demonstrates how to retrieve the initial U parameter value using the Automation syntax. This method involves directly accessing the ParamUMin property of the object.

```Automation
ParamUMin = Object.ParamUMin
```

--------------------------------

### Get CutObjects Property (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/icut_cutobjects

Retrieves the CutObjects property from an object using the Automation interface. This property represents the cutting objects (sketches and surfaces) used in an operation. No specific dependencies are mentioned, and the input is an object, with the output being the CutObjects.

```Automation
CutObjects = Object.GetCutObjects()
```

--------------------------------

### Get Dimension Text Width (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/idimensiontext_width

Retrieves the width of a dimension text using the COM interface. This method is read-only and returns the width in millimeters. It requires an object representing the dimension text and a variable to store the result.

```COM
Object.get_Width( &Width )
```

--------------------------------

### Simplify Property Syntax (COM)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iextensionsurface_simplify

Illustrates the syntax for retrieving and setting the Simplify property via the COM interface. This property is of type BOOL and controls edge simplification.

```COM
Object.get_Simplify( &Simplify )
Object.put_Simplify( Simplify )
```

--------------------------------

### Get/Set HideTexts Property (COM) - KOMPAS SDK

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ikompasdocument3d1_hidetexts

Illustrates how to access the HideTexts property through COM syntax. This method is used to get or set the boolean value that determines whether text labels are shown or hidden in the 3D model.

```COM
Object.get_HideTexts( &HideTexts )

Object.put_HideTexts( HideTexts )
```

--------------------------------

### Get and Set 'Side' Property (Automation)

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/iextensionsurface_side

Demonstrates how to retrieve and modify the 'Side' property of an IExtensionSurface object using Automation syntax. The 'Side' property is a boolean value where True indicates the left side and False indicates the right side.

```Automation
Side = Object.Side ' Get property
Object.Side = Side ' Set property

Side = Object.GetSide() ' Get property
Object.SetSide( Side ) ' Set property
```

--------------------------------

### IElementaryBody Interface

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/ielementarybody

Documentation for the IElementaryBody interface, which represents an elementary body in a KOMPAS-3D model. It details how to obtain the interface and its relationship within the object hierarchy.

```APIDOC
## IElementaryBody Interface

### Description
Interface for an elementary body. This interface can be obtained using the `IElementaryBodies::ElementaryBody` property or the `IElementaryBodies::Add` method.

### Hierarchy
IDispatch
IKompasAPIObject
IModelObject
IElementaryBody

### Version
KOMPAS v24

### Subsections
- IElementaryBody - properties

### Notes
This interface provides methods and properties for manipulating elementary bodies within the KOMPAS-3D environment.
```

--------------------------------

### IDimensionText Interface - Width Property

Source: https://help.ascon.ru/KOMPAS_SDK/24/ru-RU/idimensiontext_width

This section details the 'Width' property of the IDimensionText interface, which represents the width of a dimension text in millimeters. It explains how to get the property value using Automation and COM syntaxes and notes that the property is read-only.

```APIDOC
## GET /websites/help_ascon_ru_kompas_sdk_24_ru-ru/IDimensionText/Width

### Description
Retrieves the width of the dimension text in millimeters.

### Method
GET

### Endpoint
/websites/help_ascon_ru_kompas_sdk_24_ru-ru/IDimensionText/Width

### Parameters
#### Query Parameters
- **Object** (object) - Required - The object representing the dimension text.

### Request Example
```
GET /websites/help_ascon_ru_kompas_sdk_24_ru-ru/IDimensionText/Width?Object=...
```

### Response
#### Success Response (200)
- **Width** (double) - The width of the dimension text in millimeters.

#### Response Example
```json
{
  "Width": 10.5
}
```

### Notes
- This property is read-only.
- Available in KOMPAS v24.
```
Tokens:
Raw