Hide Table of Contents
GetCustomProperty Method (ISwDMDocument)

Gets the specified custom property for this document.

.NET Syntax

Visual Basic (Declaration) 
Function GetCustomProperty( _
   ByVal FieldName As System.String, _
   ByRef type As SwDmCustomInfoType _
) As System.String
Visual Basic (Usage) 
Dim instance As ISwDMDocument
Dim FieldName As System.String
Dim type As SwDmCustomInfoType
Dim value As System.String
 
value = instance.GetCustomProperty(FieldName, type)
C# 
System.string GetCustomProperty( 
   System.string FieldName,
   out SwDmCustomInfoType type
)
C++/CLI 
System.String^ GetCustomProperty( 
&   System.String^ FieldName,
&   [Out] SwDmCustomInfoType type
) 

Parameters

FieldName
Name of custom property
type
Type of custom property as defined by SwDmCustomInfoType

Return Value

Value of custom property

Example

Remarks

Before calling this method, call ISwDMDocument::GetCustomPropertyNames to populate FieldNames.

This method returns an evaluated value:

  • from when the document was last saved in SOLIDWORKS. If you called ISwDMDocument::SetCustomProperty to set a linked custom property, then you must open and save the file in SOLIDWORKS before calling this method. SOLIDWORKS must process the linked custom property before your DocumentMgr application can retrieve its evaluated value.
  • prefaced with fromparent+ for external referenced documents. Use ISwDocument17::GetCustomProperty2 to return resolved evaluated values without the fromparent+ preface.
 

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:   GetCustomProperty 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.