Shape.IsCustomPropertyLinked Method

  • Article
Visio Automation Reference

Returns whether the shape data (custom property) row in the Shape Data section of the shape's ShapeSheet spreadsheet is linked to a data row in the specified data recordset.

ms427224.vs_note(en-us,office.12).gif  Note
This Visio object or member is available only to licensed users of Microsoft Office Visio Professional 2007.

Version Information
 Version Added:  Visio 2007

Syntax

expression.IsCustomPropertyLinked(DataRecordsetID, CustomPropertyIndex)

expression   An expression that returns a Shape object.

Parameters

Name Required/Optional Data Type Description
DataRecordsetID Required Long The ID of the data recordset that contains the data row.
CustomPropertyIndex Required Long The index of the shape data (custom property) row in the Shape Data section of the shape's ShapeSheet.

Return Value
Boolean

Remarks

Call this method before calling the **GetCustomPropertyLinkedColumn**method to make sure that the shape data item (custom property row) is actually linked to a data column.

ms427224.vs_note(en-us,office.12).gif  Note
In previous versions of Visio, shape data were called custom properties.

Knowing how shapes are linked to data can help prevent conflicts and broken links when you refresh the data in one or more data recordsets.

Example

The following Microsoft Visual Basic for Applications (VBA) macro shows how to use the IsCustomPropertyLinked method to determine whether a shape's custom property row is linked to a data row in a data recordset.

Before running this macro, add at least one data recordset to the DataRecordsets collection of the document. The macro drops a shape and then tests whether the shape's first shape data item is linked to a data row in the data recordset most recently added to the collection, printing the result in the Immediate window. The test will fail, because the shape has not been linked to data. Then the shape is linked to data in the most recently added data recordset, and the test is run again.

Visual Basic for Applications 
  Public Sub IsCustomPropertyLinked_Example()

Dim vsoDataRecordset As Visio.DataRecordset
Dim vsoShape As Visio.Shape
Dim intCount As Integer
Dim boolIsLinked As Boolean
    
intCount = Visio.ActiveDocument.DataRecordsets.Count
Set vsoDataRecordset = Visio.ActiveDocument.DataRecordsets(intCount)

Set vsoShape = ActivePage.DrawRectangle(2, 2, 4, 4)

boolIsLinked = vsoShape.IsCustomPropertyLinked(vsoDataRecordset.ID, 1)

Debug.Print boolIsLinked

vsoShape.LinkToData vsoDataRecordset.ID, 1, True
boolIsLinked = vsoShape.IsCustomPropertyLinked(vsoDataRecordset.ID, 1)

Debug.Print boolIsLinked



End Sub

See Also