Application.GetBuiltInStencilFile Method (Visio)

  • Article

Returns the file path to the specified built-in, hidden stencil used to populate certain galleries in the Microsoft Visio user interface.

Version Information

Version Added: Visio 2010

Syntax

expression .GetBuiltInStencilFile(StencilType, MeasurementSystem)

expression A variable that represents an Application object.

Parameters

Name

Required/Optional

Data Type

Description

StencilType

Required

VisBuiltInStencilTypes

The stencil to retrieve. See Remarks for possible values.

MeasurementSystem

Required

VisMeasurementSystem

The measurement system for the stencil.

Return Value

String

Remarks

The StencilType parameter value must be one of the following VisBuiltInStencilTypes constants.

Constant

Value

Description

visBuiltInStencilBackgrounds

0

The hidden stencil that contains the shapes displayed in the Backgrounds gallery (Design tab).

visBuiltInStencilBorders

1

The hidden stencil that contains the shapes displayed in the Borders and Titles gallery (Design tab).

visBuiltInStencilContainers

2

The hidden stencil that contains the shapes displayed in the Container gallery (Insert tab).

visBuiltInStencilCallouts

3

The hidden stencil that contains the shapes displayed in the Callout gallery (Insert tab).

visBuiltInStencilLegends

4

The hidden stencil that contains the shapes displayed in the Insert Legend gallery (Data tab).

Example

The following Visual Basic for Applications (VBA) code sample shows how to use the GetBuiltInStencilFile method to open the built-in, hidden, container stencil, and to add one of the containers from that stencil to the active page to contain the selected shape or shapes. Before you run this code, be sure that there is a selected shape (or a selection of shapes) on the active page.

Public Sub GetBuiltInStencilFile_Example()

    Dim vsoDocument As Visio.Document
    Set vsoDocument = Application.Documents.OpenEx(Application.GetBuiltInStencilFile(visBuiltInStencilContainers, visMSUS), visOpenHidden)
    Application.ActivePage.DropContainer vsoDocument.Masters.ItemU("Container 1"), Application.ActiveWindow.Selection
    vsoDocument.Close

End Sub