Window.DockedStencils メソッド (Visio)

Microsoft Visio の図面ウィンドウに固定されているすべてのステンシルの名前を返します。

構文

式。 DockedStencils( _NameArray()_ )

式Window オブジェクトを表す変数。

パラメーター

名前	必須 / オプション	データ型	説明
NameArray()	必須	String	出力パラメーターです。 ウィンドウに固定されているステンシル名を受け取る配列です。

戻り値

なし

解説

DockedStencils メソッドは、文字列の配列 (ウィンドウのドッキングされたステンシル ウィンドウに表示されるステンシルの名前) を返します。 ウィンドウが描画ウィンドウの場合、ドッキングされたステンシル ウィンドウ ( n ) の数は 0 以上、ウィンドウが描画ウィンドウでない場合は n は 0 になります。

DockedStencils メソッドの実行が正常に終了すると、NameArray() には、0 ～ n - 1 のインデックスが割り当てられた n 個の文字列で構成される 1 次元配列が返されます。 NameArray() パラメーターは、DockedStencils メソッドによって割り当てられる out パラメーターであり、その所有権は呼び出し元に返されます。 最終的には、呼び出し側は、返された配列に対して SafeArrayDestroy プロシージャを実行する必要があります。 最終的には、呼び出し側は、返された配列に対して SafeArrayDestroy プロシージャを実行する必要があります。 NameArray() が null の場合、DockedStencils メソッドは失敗します。 NameArray() が Null の場合、DockedStencils メソッドは失敗します (Microsoft Visual Basic および Visual Basic for Applications では配列が自動的に破棄されます)。

strStencilName が NameArray(StencilName)によって返される文字列の場合、Documents.Item ( strStencilName) は成功し、ステンシルを表す Document オブジェクトを返します。

例

次の Microsoft Visual Basic for Applications マクロは、DockedStencils メソッドを使用して、作業中のウィンドウ内に固定されているすべてのステンシルの図面名を取得する方法を示します。 また、このマクロは、[イミディエイト] ウィンドウにアクティブな図面の名前とステンシル名を含む配列の下限と上限を表示し、ステンシル名とパスも [イミディエイト] ウィンドウに表示します。

 
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

サポートとフィードバック

Office VBA またはこの説明書に関するご質問やフィードバックがありますか？ サポートの受け方およびフィードバックをお寄せいただく方法のガイダンスについては、Office VBA のサポートおよびフィードバックを参照してください。