AddNamedRow method

AddNamedRow method

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

See also         Example         Applies to

Adds a row with the specified name to the specified ShapeSheet section.

Version added

4.0

Syntax

        
          retVal = object.AddNamedRow (section, rowName, rowTag)
      

retVal

Integer. The row number of the new row.

object

Required. An expression that returns a Shape object.

section

Required Integer. The section in which the row is to be added.

rowName

Required String. The name of the new row.

rowTag

Required Integer. The type of row to be added.

Remarks

You can add named rows to the Custom Properties (visSectionProp), User-defined Cells (visSectionUser), and Connection Points (visSectionConnectionPts) ShapeSheet sections. You can access cells in the new rows by passing the row number returned by the AddNamedRow method to the CellsSRC property. Alternatively, you can access cells in the new rows using the row's name with the Cells property. For details about cell references and cells in named rows, see the User.Row, Prop.Name, or Connections.Row row topics.

An empty row name string ("") creates a row with a default name.

A value of zero (0) in the rowTag argument generates the default row type for the section. Explicit tags are useful when adding rows to the Connection Points section. See the RowType property for descriptions of valid row types for each section. Passing an invalid row type generates an error.

Adding a named row to a Connection Points section automatically converts any existing unnamed rows in the section into named rows, using their default names (Row_1, Row_2, and so on).