Método Window.DockedStencils (Visio)

Retorna os nomes de todos os estênceis encaixados em uma janela de desenho do Microsoft Visio.

Sintaxe

expression. DockedStencils( _NameArray()_ )

Expressão Uma variável que representa um objeto Window .

Parâmetros

Nome	Obrigatório/Opcional	Tipo de dados	Descrição
NameArray()	Obrigatório	String	Parâmetro externo. Uma matriz que recebe os nomes de estênceis encaixados em uma janela.

Valor de retorno

Nada

Comentários

O método DockedStencils retorna uma série de sequências de caracteres — os nomes dos estênceis exibidos nos painéis de estênceis encaixados de uma janela. Quando a janela é uma janela de desenho, o número de painéis de estêncil encaixados ( n ) é igual ou maior que zero, e n é zero quando a janela não é uma janela de desenho.

Se o método DockedStencils for bem-sucedido, NameArray() retornará uma matriz unidimensional de n sequências de caracteres indexadas a partir de zero (0) até n - 1. O parâmetro NameArray() é um parâmetro out alocado pelo método DockedStencils , cujo domínio é passado de volta para o chamador. Por fim, o chamador deve executar o procedimento SafeArrayDestroy na matriz retornada. Observe que o procedimento SafeArrayDestroy tem o efeito colateral de libertar as sequências de caracteres referenciadas pelas entradas da matriz. O método DockedStencils irá falhar se NameArray() for nulo. (O Microsoft Visual Basic e o Visual Basic for Applications se encarregam de destruir a matriz para você.)

Se strStencilName for a cadeia de caracteres retornada por NameArray(StencilName), Documents.Item ( strStencilName) terá êxito e retornará um objeto Document que representa o estêncil.

Exemplo

A seguinte macro do Microsoft Visual Basic for Applications mostra como usar o método DockedStencils para obter os nomes de documento de todos os estênceis encaixados na janela ativa. Ele também imprime, na janela Immediate, o nome do documento ativo e os limites superiores e inferiores da matriz que mantém os nomes dos estênceis e lista os nomes e caminhos do estêncil, também na janela Immediate.

 
Public Sub DockedStencils_Example() 
 
 Dim astrStencilNames() As String 
 ActiveWindow.DockedStencils astrStencilNames 
 
 Dim intLowerBound As Integer 
 Dim intUpperBound As Integer 
 Dim intIndex As Integer 
 
 intLowerBound = LBound(astrStencilNames) 
 intUpperBound = UBound(astrStencilNames) 
 Debug.Print "Active document: " ActiveWindow.Document; " Lower bound:"; intLowerBound; " Upper Bound:"; intUpperBound 
 
 intIndex = intLowerBound 
 While intIndex <= intUpperBound 
 Debug.Print astrStencilNames(intIndex) 
 intIndex = intIndex + 1 
 Wend 
 
End Sub

Suporte e comentários

Tem dúvidas ou quer enviar comentários sobre o VBA para Office ou sobre esta documentação? Confira Suporte e comentários sobre o VBA para Office a fim de obter orientação sobre as maneiras pelas quais você pode receber suporte e fornecer comentários.