Class DocumentAPIImpl
Last update: 16.07.2025Namespace: VM.API.Pre
Assembly: VM.API.Pre.dll
This class implements APIs for document.
public static class DocumentAPIImpl
Inheritance
Extension Methods
LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)
Methods
CreateNewPartDocumentImpl<T>(string, string, Unit, double, LengthUnitType, string, string)
Create
[NotNullOrEmpty(new string[] { "newPartFilePath" })]
public static T CreateNewPartDocumentImpl<T>(string newPartFilePath, string documentName, Unit unit, double iconSize, LengthUnitType kernelLengthUnit, string extension, string documentType) where T : PartDocument
Parameters
newPartFilePath string
The file path of new part.
documentName string
The name of document.
unit Unit
The unit information.
iconSize double
The size of icon.
kernelLengthUnit LengthUnitType
The length unit of kernel.
extension string
The extension.
documentType string
The document type.
Returns
T
The new
Type Parameters
T
The document type
Exceptions
Will be thrown if 'newPartFilePath' argument is null.
CreateNewSubsystemDocumentCore<T>(string, DocCreateInfo, string, string)
Create
[NotNullOrEmpty(new string[] { "newSubsystemFilePath" })]
public static T CreateNewSubsystemDocumentCore<T>(string newSubsystemFilePath, DocCreateInfo info, string extension, string documentType) where T : DocumentAnalysis
Parameters
newSubsystemFilePath string
The file path of new subsystem.
info DocCreateInfo
The information of document.
extension string
The extension.
documentType string
The document type.
Returns
T
The new
Type Parameters
T
The document type
Exceptions
Will be thrown if 'newSubsystemFilePath' argument is null.
CreateNewSubsystemDocumentImpl<T>(string, string, Vector, Unit, double, bool, Plane, bool, LengthUnitType, string, string)
Create
[NotNullOrEmpty(new string[] { "newSubsystemFilePath" })]
public static T CreateNewSubsystemDocumentImpl<T>(string newSubsystemFilePath, string documentName, Vector gravity, Unit unit, double iconSize, bool advancedMode, Plane symmetricPlane, bool useSymmetric, LengthUnitType kernelLengthUnit, string extension, string documentType) where T : SubSystemDocument
Parameters
newSubsystemFilePath string
The file path of new subsystem.
documentName string
The name of document.
gravity Vector
The gravity value.
unit Unit
The unit information.
iconSize double
The size of icon.
advancedMode bool
The flag whether using advanced mode.
symmetricPlane Plane
The symetric plane.
useSymmetric bool
The flag whether using symmetric.
kernelLengthUnit LengthUnitType
The length unit of kernel.
extension string
The extension.
documentType string
The document type.
Returns
T
The new
Type Parameters
T
The document type
Exceptions
Will be thrown if 'newSubsystemFilePath' argument is null.
CreateNewSubsystemFromTemplateDocumentImpl<T>(string, string, string, string)
Create
[NotNullOrEmpty(new string[] { "newSubsystemFromTemplateFilePath" })]
[ExistFile(new string[] { "existedSubsystemTemplateFilePath" })]
public static T CreateNewSubsystemFromTemplateDocumentImpl<T>(string newSubsystemFromTemplateFilePath, string existedSubsystemTemplateFilePath, 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.
extension string
The extension.
documentType string
The document type.
Returns
T
The new
Type Parameters
T
The document type
Exceptions
Will be thrown if 'newSubsystemFromTemplateFilePath' argument is null.
Will be thrown if 'existedSubsystemTemplateFilePath' does not exist.
