Skip to main content

Motion Standalone Preprocessor C# library 2024 R2

Class DocumentAPIImpl

Last update: 16.07.2025

Namespace: VM.API.Pre.Car
Assembly: VM.API.Pre.Car.dll

This class implements APIs for document.

public static class DocumentAPIImpl

Inheritance

object ← DocumentAPIImpl

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)

Methods

CreateNewPropertyDocumentImpl<T>(string, string, Unit, LengthUnitType, string, string)

Create .

[NotNullOrEmpty(new string[] { "newPropertyFilePath" })]
public static T CreateNewPropertyDocumentImpl<T>(string newPropertyFilePath, string documentName, Unit unit, LengthUnitType kernelLengthUnit, string extension, string documentType) where T : PropertyDocumentBase

Parameters

newPropertyFilePath string

The file path of new property document.

documentName string

The name of document.

unit Unit

The unit information.

kernelLengthUnit LengthUnitType

The length unit of kernel.

extension string

The extension.

documentType string

The document type.

Returns

T

The new object that is created by this API.

Type Parameters

T

The document type

Exceptions

ArgumentNullException

Will be thrown if 'newPropertyFilePath' argument is null.

CreateNewSubsystemFromTemplateDocumentImpl<T>(string, string, MinorRole, string, string)

Create .

[NotNullOrEmpty(new string[] { "newSubsystemFromTemplateFilePath" })]
[ExistFile(new string[] { "existedSubsystemTemplateFilePath" })]
public static T CreateNewSubsystemFromTemplateDocumentImpl<T>(string newSubsystemFromTemplateFilePath, string existedSubsystemTemplateFilePath, MinorRole minorRole, string extension, string documentType) where T : SubSystemDocument

Parameters

newSubsystemFromTemplateFilePath string

The file path of new subsystem from template file path.

existedSubsystemTemplateFilePath string

The file path of existed subsystem template file path.

minorRole MinorRole

The minor role type.

extension string

The extension.

documentType string

The document type.

Returns

T

The new object that is created by this API.

Type Parameters

T

The document type

Exceptions

ArgumentNullException

Will be thrown if 'newSubsystemFromTemplateFilePath' argument is null.

FileNotFoundException

Will be thrown if 'existedSubsystemTemplateFilePath' does not exist.

Connect with Ansys