Hide Table of Contents
AddCustomProperty Method (ISwDMDocument)

Adds a custom property to document.

.NET Syntax

Visual Basic (Declaration) 
Function AddCustomProperty( _
   ByVal FieldName As System.String, _
   ByVal FieldType As SwDmCustomInfoType, _
   ByVal FieldValue As System.String _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As ISwDMDocument
Dim FieldName As System.String
Dim FieldType As SwDmCustomInfoType
Dim FieldValue As System.String
Dim value As System.Boolean
 
value = instance.AddCustomProperty(FieldName, FieldType, FieldValue)
C# 
System.bool AddCustomProperty( 
   System.string FieldName,
   SwDmCustomInfoType FieldType,
   System.string FieldValue
)
C++/CLI 
System.bool AddCustomProperty( 
&   System.String^ FieldName,
&   SwDmCustomInfoType FieldType,
&   System.String^ FieldValue
) 

Parameters

FieldName
Name of custom property
FieldType
Type of custom property as defined by SwDmCustomInfoType
FieldValue
Value for custom property

Return Value

True if custom property is added, false if not

Remarks

This method also returns false if you attempt to add a custom property name that already exists.

 

If you call this method to add a linked custom property with an expression value, then you need to open and save the file in SOLIDWORKS before calling ISwDMDocument::GetCustomPropertyISwDMDocument17::GetCustomProperty2ISwDMDocument3::GetAllCustomPropertyNamesAndValues, or ISwDMDocument5::GetCustomPropertyValues. SOLIDWORKS needs to process the linked custom property before your DocumentMgr application attempts to get its evaluated value.

 

 

See Also

Availability

SOLIDWORKS Document Manager API 2004 FCS


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   AddCustomProperty Method (ISwDMDocument)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:




x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2024 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.