Name Property [Visio 2003 SDK Documentation]

Article
05/01/2007

Specifies the name of an object.

strRet = object**.Name**

object**.Name** = stringExpression

strRet String. The current name of the object.

object Required. An expression that returns an object from the Applies to list.

stringExpression Required String. The new name of the object.

Version added

2.0

Remarks

You can get, but not set, the Name property of a Document object. If a document is not yet named, this property returns the document's temporary name, such as Drawing1 or Stencil1.

You can get, but not set, the Name property of an Addon object or a Font object.

You can get, but not set, the Name property of a Cell object. Some cells are in named rows; you can get and set the name of a named row by using the RowName property.

You can set the Name property of a Style object that represents a style that is not a default Microsoft Office Visio style. If you attempt to set the Name property of a default Visio style, an error is generated.

A cell has both a local name and a universal name. The local name differs depending on the locale for which the running version of Microsoft Windows is installed. The universal name is the same regardless of what locale is installed. To get the universal name of a cell, use the Name property. To get the local name, use the LocalName property.

Note Beginning with Microsoft Visio 2000, you can use both local and universal names to refer to Visio shapes, masters, documents, pages, rows, add-ons, cells, hyperlinks, styles, fonts, master shortcuts, UI objects, and layers. When a user names a shape, for example, the user is specifying a local name. Beginning with Microsoft Office Visio 2003, the ShapeSheet spreadsheet displays only universal names in cell formulas and values. (In prior versions, universal names were not visible in the user interface.)

As a developer, you can use universal names in a program when you don't want to change a name each time a solution is localized. Use the Name property to get or set a Hyperlink, Layer, Master, MasterShortcut, Page, Shape, Style, or Row object's local name. Use the NameU property to get or set its universal name.

Example

This Microsoft Visual Basic for Applications (VBA) macro shows how to use the Name property to display layer names. It also uses the Layer property to get a reference to a particular layer and the LayerCount property to determine the number of layers to which a shape is assigned.

Public Sub Name_Example()
 
    Dim vsoPage As Visio.Page 
    Dim vsoShape As Visio.Shape 
    Dim vsoLayers As Visio.Layers 
    Dim vsoLayer As Visio.Layer 

    If ActiveDocument Is Nothing Then
        Documents.Add ("") 
    End If
  
    Set vsoPage = ActivePage 
    If vsoPage Is Nothing Then
        Set vsoPage = ActiveDocument.Pages(1) 
    End If  

    'Draw a rectangle.
    Set vsoShape = vsoPage.DrawRectangle(1, 5, 5, 1) 

    'Get the Layers collection.
    Set vsoLayers = vsoPage.Layers 

    'Create a layer named ExampleLayer1 and add the shape to it.
    Set vsoLayer = vsoLayers.Add("ExampleLayer1") 
    vsoLayer.Add vsoShape, 1 

    'Create a layer named ExampleLayer2 and add the shape to it.
    Set vsoLayer = vsoLayers.Add("ExampleLayer2") 
    vsoLayer.Add vsoShape, 1 

    'Verify that the shape has been assigned to 2 layers. 
    Debug.Print "The page has " & vsoShape.LayerCount & " layers." 

    'Get a reference to the first layer.
    Set vsoLayer = vsoShape.Layer(1) 

    'Verify by using the Name property. 
    Debug.Print "Current vsoLayer name is """ & vsoLayer.Name & ".""" 

End Sub

Share via

Name Property [Visio 2003 SDK Documentation]

Version added

Remarks

Example

Additional resources