CellsSRC Property [Visio 2003 SDK Documentation]

Returns a Cell object that represents a ShapeSheet cell identified by section, row, and column indices.

objRet = object**.CellsSRC** (section, row, column)**

objRet     A Cell object that represents the requested cell.

object     Required. An expression that returns a Shape or Style object. A Shape can also be a DocumentSheet or PageSheet.

section     Required Integer. The cell's section index.

row     Required Integer. The cell's row index.

column     Required Integer. The cell's column index.

Version added

2.0

Remarks

To access any shape formula by its section, row, and column indices, use the CellsSRC property. Constants for section, row, and column indices are declared by the Visio type library as members of VisSectionIndices, VisRowIndices, and VisCellIndices, respectively.

The CellsSRC property might raise an exception if index values for section, row, and column do not identify an actual cell, depending on the section. However, even if no exception is raised, subsequent methods invoked on the returned object fail. You can determine if a cell with particular index values exists by using the CellsSRCExists property.

The CellsSRC property is typically used to iterate through the cells in a section or row. To retrieve a single cell, use the Cells property and specify a cell name. For example:

Set vsoCell = Cells("PinX")

Example

The following Microsoft Visual Basic for Applications (VBA) macro shows how to use the CellsSRC property to set a particular ShapeSheet cell by its section, row, and column indices. It draws a rectangle on a page and bows, or curves the lines of the rectangle by changing the shape's lines to arcs. The macro then draws an inner rectangle within the bowed lines of the first rectangle.

Public Sub CellsSRC_Example()
 
    Dim vsoPage As Visio.Page 
    Dim vsoShape As Visio.Shape 
    Dim vsoCell As Visio.Cell 
    Dim strBowCell As String
    Dim strBowFormula As String
    Dim intIndex As Integer
    Dim intCounter As Integer

    'Set the value of the strBowCell string. 
    strBowCell = "Scratch.X1" 

    'Set the value of the strBowFormula string. 
    strBowFormula = "=Min(Width, Height) / 5" 

    Set vsoPage = ActivePage 

    'If there isn't an active page, set vsoPage
    'to the first page of the active document.
    If vsoPage Is Nothing Then
        Set vsoPage = ActiveDocument.Pages(1) 
    End If  

    'Draw a rectangle on the active page.
    Set vsoShape = vsoPage.DrawRectangle(1, 5, 5, 1) 

    'Add a scratch section to the shape's ShapeSheet 
    vsoShape.AddSection visSectionScratch 

    'Add a row to the scratch section. 
    vsoShape.AddRow visSectionScratch, visRowScratch, 0 

    'Set vsoCell to the Scratch.X1 cell and set its formula.
    Set vsoCell = vsoShape.Cells(strBowCell) 
    vsoCell.Formula = strBowFormula 

    'Bow in or curve the rectangle's lines by changing
    'each row type from LineTo to ArcTo and entering the bow value.
    For intCounter = 1 To 4 
        vsoShape.RowType(visSectionFirstComponent, visRowVertex + intCounter) = visTagArcTo 
        Set vsoCell = vsoShape.CellsSRC(visSectionFirstComponent, visRowVertex + intCounter, 2) 
        vsoCell.Formula = "-" & strBowCell 
    Next intCounter 

    'Create an inner rectangle.
    'Set the section index for the inner rectangle's Geometry section. 
    intIndex = visSectionFirstComponent + 1 

    'Add an inner rectangle Geometry section. 
    vsoShape.AddSection intIndex 

    'Add the first 2 rows to the section. 
    vsoShape.AddRow intIndex, visRowComponent, visTagComponent 
    vsoShape.AddRow intIndex, visRowVertex, visTagMoveTo
 
    'Add 4 LineTo rows to the section
    For intCounter = 1 To 4 
        vsoShape.AddRow intIndex, visRowLast, visTagLineTo 
    Next intCounter 

    'Set the inner rectangle start point cell formulas.
    Set vsoCell = vsoShape.CellsSRC(intIndex, 1, 0) 
    vsoCell.Formula = "Width * 0 + " & strBowCell 
    Set vsoCell = vsoShape.CellsSRC(intIndex, 1, 1) 
    vsoCell.Formula = "Height * 0 + " & strBowCell 

    'Draw the inner rectangle bottom line.
    Set vsoCell = vsoShape.CellsSRC(intIndex, 2, 0) 
    vsoCell.Formula = "Width * 1 - " & strBowCell 
    Set vsoCell = vsoShape.CellsSRC(intIndex, 2, 1) 
    vsoCell.Formula = "Height * 0 + " & strBowCell
 
    'Draw the inner rectangle right side line.
    Set vsoCell = vsoShape.CellsSRC(intIndex, 3, 0) 
    vsoCell.Formula = "Width * 1 - " & strBowCell 
    Set vsoCell = vsoShape.CellsSRC(intIndex, 3, 1) 
    vsoCell.Formula = "Height * 1 - " & strBowCell 

    'Draw the inner rectangle top line.
    Set vsoCell = vsoShape.CellsSRC(intIndex, 4, 0) 
    vsoCell.Formula = "Width * 0 + " & strBowCell 
    Set vsoCell = vsoShape.CellsSRC(intIndex, 4, 1) 
    vsoCell.Formula = "Height * 1 - " & strBowCell 

    'Draw the inner rectangle left side line.
    Set vsoCell = vsoShape.CellsSRC(intIndex, 5, 0) 
    vsoCell.Formula = "Geometry2.X1" 
    Set vsoCell = vsoShape.CellsSRC(intIndex, 5, 1) 
    vsoCell.Formula = "Geometry2.Y1" 

End Sub

Applies to | Shape object | Style object

See Also | AddRow method | AddSection method | Cells property | CellsSRCExists property