Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Expand SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand PDM Pro API Web ServicePDM Pro API Web Service
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Inspection API HelpSOLIDWORKS Inspection API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Collapse DraftSight API HelpDraftSight API Help
Welcome
Getting Started
Release Notes
Access Diagram
Collapse Interop.dsAutomation NamespaceInterop.dsAutomation Namespace
Overview
Collapse InterfacesInterfaces
Expand FileDialogManagerFileDialogManager
Expand IAlignedDimensionIAlignedDimension
Expand IAngularDimensionIAngularDimension
Expand IApplicationIApplication
Expand IApplicationOptionsIApplicationOptions
Expand IArcAlignedTextIArcAlignedText
Expand IArcLengthDimensionIArcLengthDimension
Expand IAttributeDefinitionIAttributeDefinition
Expand IAttributeInstanceIAttributeInstance
Expand IBlockDefinitionIBlockDefinition
Expand IBlockInstanceIBlockInstance
Expand ICircleICircle
Expand ICircleArcICircleArc
Expand IColorIColor
Expand IColorPickerIColorPicker
Expand ICommandICommand
Expand ICommandMessageICommandMessage
Expand IContextMenuItemIContextMenuItem
Expand ICurvedSettingsICurvedSettings
Expand ICustomCoordinateSystemICustomCoordinateSystem
Expand ICustomCoordinateSystemManagerICustomCoordinateSystemManager
Expand ICustomDataICustomData
Expand ICustomPropertyControlICustomPropertyControl
Expand IDgnDefinitionIDgnDefinition
Expand IDgnReferenceIDgnReference
Expand IDiameterDimensionIDiameterDimension
Expand IDictionaryIDictionary
Expand IDimensionStyleIDimensionStyle
Expand IDimensionStyleAngularDimensionOptionsIDimensionStyleAngularDimensionOptions
Expand IDimensionStyleArrowsOptionsIDimensionStyleArrowsOptions
Expand IDimensionStyleDualDimensionOptionsIDimensionStyleDualDimensionOptions
Expand IDimensionStyleFitOptionsIDimensionStyleFitOptions
Expand IDimensionStyleLinearDimensionOptionsIDimensionStyleLinearDimensionOptions
Expand IDimensionStyleLineOptionsIDimensionStyleLineOptions
Expand IDimensionStyleManagerIDimensionStyleManager
Expand IDimensionStyleRadialDiameterDimensionOptionsIDimensionStyleRadialDiameterDimensionOptions
Expand IDimensionStyleTextOptionsIDimensionStyleTextOptions
Expand IDimensionStyleToleranceOptionsIDimensionStyleToleranceOptions
Expand IDimensionStyleUserDataIDimensionStyleUserData
Expand IDocumentIDocument
Expand IDocumentExporterIDocumentExporter
Expand IDrawingPropertiesIDrawingProperties
Expand IDrawingSupportFilesIDrawingSupportFiles
Expand IDropDataIDropData
Expand IDSWindowIDSWindow
Expand IDynamicBlockInstancePropertyIDynamicBlockInstanceProperty
Expand IEllipseArcIEllipseArc
Expand IEmbeddedObjectIEmbeddedObject
Expand IEntityHelperIEntityHelper
Expand IExportSettingsIExportSettings
Expand IExternalReferenceIExternalReference
Expand IExtrudedSurfaceIExtrudedSurface
Expand IExtrusionIExtrusion
Expand IFaceIFace
Expand IFileDialogManagerIFileDialogManager
Expand IGeneralDimensionIGeneralDimension
Expand IGradientBackgroundIGradientBackground
Expand IGroupIGroup
Expand IHatchIHatch
Expand IHatchBoundaryLoopIHatchBoundaryLoop
Expand IHatchPatternIHatchPattern
Expand IHighlightSetIHighlightSet
Expand IHyperLinkIHyperLink
Expand IImageBackgroundIImageBackground
Expand IImageDefinitionIImageDefinition
Expand IInfiniteLineIInfiniteLine
Expand IInterfaceFilesIInterfaceFiles
Expand IJoggedDimensionIJoggedDimension
Expand ILayerILayer
Expand ILayerManagerILayerManager
Expand ILayerPropertiesILayerProperties
Expand ILayerStateILayerState
Expand ILayerStateManagerILayerStateManager
Expand ILeaderILeader
Expand ILineILine
Expand ILineStyleILineStyle
Expand ILineStyleManagerILineStyleManager
Expand ILispFunctionILispFunction
Expand ILispParameterILispParameter
Expand ILoftILoft
Expand ILoftedSurfaceILoftedSurface
Expand IMacroManagerIMacroManager
Expand IMathCircArcIMathCircArc
Expand IMathEllipArcIMathEllipArc
Expand IMathLineIMathLine
Expand IMathPlaneIMathPlane
Expand IMathPointIMathPoint
Expand IMathTransformIMathTransform
Expand IMathUtilityIMathUtility
Expand IMathVectorIMathVector
Expand IMenuItemIMenuItem
Expand IModelIModel
Expand IModelNamedViewIModelNamedView
Expand INamedViewINamedView
Expand INoteINote
Expand IOrdinateDimensionIOrdinateDimension
Expand IPdfDefinitionIPdfDefinition
Expand IPdfReferenceIPdfReference
Expand IPointIPoint
Expand IPolyFaceMeshIPolyFaceMesh
Expand IPolygonMeshIPolygonMesh
Expand IPolyLineIPolyLine
Expand IPolyLine3DIPolyLine3D
Expand IPrintManagerIPrintManager
Expand IPrintSpecificationIPrintSpecification
Expand IProfileManagerIProfileManager
Expand IRadialDimensionIRadialDimension
Expand IRayIRay
Expand IReferenceImageIReferenceImage
Expand IReferenceManagerIReferenceManager
Expand IRegionIRegion
Expand IRevolveIRevolve
Expand IRevolvedSurfaceIRevolvedSurface
Expand IRibbonCommandButtonIRibbonCommandButton
Expand IRibbonPanelIRibbonPanel
Expand IRibbonQuickAccessBarIRibbonQuickAccessBar
Expand IRibbonQuickAccessBarItemIRibbonQuickAccessBarItem
Expand IRibbonRowIRibbonRow
Expand IRibbonRowItemIRibbonRowItem
Expand IRibbonRowPanelIRibbonRowPanel
Expand IRibbonSeparatorIRibbonSeparator
Expand IRibbonSplitButtonIRibbonSplitButton
Expand IRibbonSystemMenuIRibbonSystemMenu
Expand IRibbonSystemMenuItemIRibbonSystemMenuItem
Expand IRibbonTabIRibbonTab
Expand IRichLineIRichLine
Expand IRichLineStyleIRichLineStyle
Expand IRichLineStyleManagerIRichLineStyleManager
Expand IRotatedDimensionIRotatedDimension
Expand ISelectionFilterISelectionFilter
Expand ISelectionManagerISelectionManager
Expand IShapeIShape
Expand IShapeManagerIShapeManager
Expand ISheetISheet
Expand ISheetNamedViewISheetNamedView
Expand ISimpleNoteISimpleNote
Expand ISketchManagerISketchManager
Expand ISolidISolid
Expand ISolid3DISolid3D
Expand ISolidBackgroundISolidBackground
Expand ISplineISpline
Expand ISweepISweep
Expand ISweptSurfaceISweptSurface
Expand ISystemFilesISystemFiles
Expand ITableITable
Expand ITableStyleITableStyle
Expand ITableStyleManagerITableStyleManager
Expand ITextStyleITextStyle
Expand ITextStyleManagerITextStyleManager
Expand IToleranceITolerance
Expand IToolbarIToolbar
Expand IToolbarItemIToolbarItem
Expand ITraceITrace
Expand ITrackerITracker
Expand ITransparencyITransparency
Expand IUnknownEntityIUnknownEntity
Expand IUserCommandIUserCommand
Expand IViewManagerIViewManager
Expand IViewportIViewport
Expand IViewTileIViewTile
Expand IWorkspaceIWorkspace
Expand IXRecordIXRecord
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
ICustomData Interface

Allows access to custom data.

.NET Syntax

Visual Basic (Declaration) 
Public Interface ICustomData
C# 
public interface ICustomData
JScript 
public interface ICustomData
Managed Extensions for C++ 
public __gc __interface ICustomData
C++/CLI 
public interface class ICustomData

Example

Remarks

Custom data is non-graphical information that you can add to an entity in a drawing to supplement the data available via the entity's interface.

Custom data is made up of:

  • Markers, which are stored as integers and which help identify the data type of the custom data. Valid values for markers are shown in the following table.
  • Data, which are variable data types such as strings, doubles, integers, etc.

Marker Data Data type
1000 Text String
1003 Layer name String
1004 Binary chunk Variable-length binary array; maximum of 127 bytes
1005 Handle of an entity String
1010 − 1013 Point Three numbers
1020 − 1059 Double Double
1060 − 1070 Integer Signed 16-bit integer, also called Int16
1071 Integer Signed 32-bit integer, also called Int32

Custom data is stored in an entity using markers.

Because multiple applications can add custom data to an entity, use unique names to differentiate your custom data from that of other applications. Custom data names are stored in a drawing document's list of registered applications, which you can search to determine a unique name for your custom data.

After determining a unique name for your custom data, use an entity's:

  • GetCustomData method to create the entity's CustomData object. Use the ICustomData methods to add data to the entity's CustomData object.
  • SetCustomData method to change an entity's CustomData object.
  • DeleteCustomData method to delete an entity's CustomData object.
  • Handle property to get the entity's CustomData object's handle. Because entities can reference other entities by saving the handles of other entities in their custom data, handles do not have to be unique.

Accessors

IArcAlignedText::GetCustomData

IAttributeDefinition::GetCustomData

IAttributeInstance::GetCustomData

IBlockDefinition::GetCustomData

IBlockInstance::GetCustomData 

ICircle::GetCustomData

ICircleArc::GetCustomData

ICustomData::GetCustomData 

ICustomData::InsertCustomData

IDgnDefinition::GetCustomData

IDgnReference::GetCustomData 

IDictionary::GetCustomData

IDimensionStyle::GetCustomData

IEllipseArc::GetCustomData

IEmbeddedObject::GetCustomData 

IEntityHelper::GetCustomData

IExtrudedSurface::GetCustomData

IExtrusion::GetCustomData

IFace::GetCustomData

IGeneralDimension::GetCustomData 

IHatch::GetCustomData

IImageDefinition::GetCustomData

IInfiniteLine::GetCustomData

ILayer::GetCustomData

ILeader::GetCustomData

ILine::GetCustomData  

ILineStyle::GetCustomData

ILoft::GetCustomData

ILoftedSurface::GetCustomData

IModel::GetCustomData

INote::GetCustomData

IPdfDefinition::GetCustomData

IPdfReference::GetCustomData

IPoint::GetCustomData

IPolyFaceMesh::GetCustomData

IPolygonMesh::GetCustomData

IPolyLine::GetCustomData

IPolyLine3D::GetCustomData

IRay::GetCustomData

IReferenceImage::GetCustomData

IRegion::GetCustomData

IRevolve::GetCustomData

IRevolvedSurface::GetCustomData

IRichLine::GetCustomData

IRichLineStyle::GetCustomData

IShape::GetCustomData

ISheet::GetCustomData

ISimpleNote::GetCustomData

ISolid::GetCustomData

ISolid3D::GetCustomData

ISpline::GetCustomData

ISweep::GetCustomData

ISweptSurface::GetCustomData 

ITable::GetCustomData

ITextStyle::GetCustomData

ITolerance::GetCustomData

ITrace::GetCustomData

IUnknownEntity::GetCustomData

IViewport::GetCustomData

IViewTile::GetCustomData

IXRecord::GetCustomData

Access Diagram

See Also



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:   ICustomData Interface
*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 SP03

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.

0.20.61