Share via

AddGuide Method [Visio 2003 SDK Documentation]

  • Article

Adds a guide to a drawing page.

objRet = object**.AddGuide** (Type, xPos, yPos)

objRet     A Shape object that represents the new guide.

object     Required. An expression that returns a Master, Page, or Shape object.

Type     Required Integer. The type of guide to add.

xPos     Required Double. The x-coordinate of a point on the guide.

yPos     Required Double. The y-coordinate of a point on the guide.

Version added

2.0

Remarks

The following constants declared by the Visio type library are valid values for guide types.

Constant Value Description

visPoint

1

Guide point

visHorz

2

Horizontal guide

visVert

3

Vertical guide

Example

The following macro shows how to add a horizontal guide to a page.

Public Sub AddGuide_Example()
 
    Dim vsoPages As Visio.Pages 
    Dim vsoPage As Visio.Page 
    Dim vsoShapes As Visio.Shapes 
    Dim vsoShape As Visio.Shape
    Dim vsoPageHeightCell as Visio.Cell
    Dim intPageHeightIU as Integer 

    'Get the Pages collection of the ThisDocument object.
    Set vsoPages = ThisDocument.Pages 

    'Set the Page object to the first page of the Pages collection.
    Set vsoPage = vsoPages(1) 

    'Get the Shapes collection of the vsoPage object.
    Set vsoShapes = vsoPage.Shapes    
    
    'Get the page height in internal units.
    Set vsoPageHeightCell = vsoPage.PageSheet.CellsSRC( _
                         visSectionObject, visRowPage, visPageHeight)
    intPageHeightIU = vsoPageHeightCell.ResultIU    

    'Add a guide to the Shapes collection and set it
    'as the vsoShape object. The guide is a horizontal line
    'running through the middle of the page.            
    Set vsoShape = vsoPage.AddGuide(visHorz,0,intPageHeightIU/2)
 
End Sub

Applies to | Master object | Page object | Shape object

See Also | Shape object