SnapStrengthRulerY Property [Visio 2003 SDK Documentation]

Specifies the distance in pixels along the y-axis that rulers pull when snapping is enabled.

longRet = object.SnapStrengthRulerY

object.SnapStrengthRulerY = longVal

longRet    Long. Current y-axis snap strength for rulers.

object    Required. An expression that returns an ApplicationSettings object.

longVal   Required Long. New y-axis snap strength for rulers.

Version added

2003

Remarks

Setting the SnapStrengthRulerY property is equivalent to setting the Rulers option under Snap strength on the Advanced tab in the Snap & Glue dialog box (Tools menu). Setting snap strength in the UI sets both x and y values to the same value.

The minimum allowable value for the SnapStrengthRulerY property is 0 (zero), and the maximum is 999. Attempting to set a value outside that range returns an error. The default value is 4.

Example

This Microsoft Visual Basic for Applications (VBA) macro shows how to use the SnapStrengthRulerY property to print the current snap strength ruler y-axis setting in the Immediate window. It also shows how to get an ApplicationSettings object from the Visio Application object.

Public Sub SnapStrengthRulerY_Example()

    Dim vsoApplicationSettings As Visio.ApplicationSettings
    Dim lngSnapStrength As Long

    Set vsoApplicationSettings = Visio.Application.Settings
    lngSnapStrength = vsoApplicationSettings.SnapStrengthRulerY

    Debug.Print lngSnapStrength

End Sub

Applies to | ApplicationSettings object

See Also | SnapStrengthExtensionsX property | SnapStrengthExtensionsY property