ControlExtensions.AddLabel メソッド (ControlCollection, Single, Single, Single, Single, String)
サイズと位置を指定して、新しい Label コントロールを文書に追加します。
名前空間: Microsoft.Office.Tools.Word
アセンブリ: Microsoft.Office.Tools.Word.v4.0.Utilities (Microsoft.Office.Tools.Word.v4.0.Utilities.dll 内)
構文
'宣言
<ExtensionAttribute> _
Public Shared Function AddLabel ( _
controls As ControlCollection, _
left As Single, _
top As Single, _
width As Single, _
height As Single, _
name As String _
) As Label
public static Label AddLabel(
this ControlCollection controls,
float left,
float top,
float width,
float height,
string name
)
パラメーター
- controls
型 : Microsoft.Office.Tools.Word.ControlCollection
コントロールを追加するコレクション。このパラメーターは手動で指定しないでください。(アプリケーション レベルのプロジェクトの) Document.Controls プロパティまたは (ドキュメント レベルのプロジェクトの) DocumentBase.Controls プロパティによって返されたコレクションでこのメソッドを呼び出す場合、このパラメーターは自動的に指定されます。
- left
型 : System.Single
コントロールの左端から文書の左端までの間隔 (ポイント単位)。
- top
型 : System.Single
コントロールの上端から文書の上端までの間隔 (ポイント単位)。
- width
型 : System.Single
コントロールの幅 (ポイント単位)。
- height
型 : System.Single
コントロールの高さ (ポイント単位)。
- name
型 : System.String
ControlCollection インスタンス内のコントロールにインデックスを作成するために使用できる名前。
戻り値
型 : Microsoft.Office.Tools.Word.Controls.Label
文書に追加されたコントロール。
使用上の注意
Visual Basic および Visual C# では、このメソッドを、ControlCollection 型のオブジェクトのインスタンス メソッドとして呼び出すことができます。インスタンス メソッド構文を使用してこのメソッドを呼び出す場合は、最初のパラメーターを省略します。詳細については、「拡張メソッド (Visual Basic)」または「拡張メソッド (C# プログラミング ガイド)」を参照してください。
例外
| 例外 | 条件 |
|---|---|
| ArgumentNullException | name 引数が nullnull 参照 (Visual Basic では Nothing) であるか、または長さが 0 である場合。 |
| ControlNameAlreadyExistsException | 同じ名前のコントロールが既に ControlCollection インスタンスに存在する場合。 |
解説
このメソッドを使用すると、Label オブジェクトを ControlCollection の最後に追加できます。
プログラムで追加された Label を削除するには、Remove メソッドを使用します。
例
次のコード例は、Label コントロールを文書の先頭に追加し、テキストを First Name に変更します。この例を使用するには、これをドキュメント レベルのプロジェクトの ThisDocument クラスから実行します。
Private Sub WordAddLabel()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Dim Label1 As Microsoft.Office.Tools.Word.Controls.Label _
= Me.Controls.AddLabel(0, 0, 75, 17.25F, "Label1")
Label1.Text = "First Name"
End Sub
private void WordAddLabel()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
Microsoft.Office.Tools.Word.Controls.Label
label1 = this.Controls.AddLabel(
0, 0, 75, 17.25F, "label1");
label1.Text = "First Name";
}
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。