PictureContentControl Class (2007 System)
Represents a document region that displays an image.
Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word.v9.0 (in Microsoft.Office.Tools.Word.v9.0.dll)
Syntax
'Declaration
<DefaultBindingPropertyAttribute("Image")> _
<PermissionSetAttribute(SecurityAction.Demand, Name := "FullTrust")> _
Public NotInheritable Class PictureContentControl _
Inherits ContentControlBase _
Implements ISupportInitializeControl, ISupportInitialize
'Usage
Dim instance As PictureContentControl
[DefaultBindingPropertyAttribute("Image")]
[PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")]
public sealed class PictureContentControl : ContentControlBase,
ISupportInitializeControl, ISupportInitialize
[DefaultBindingPropertyAttribute(L"Image")]
[PermissionSetAttribute(SecurityAction::Demand, Name = L"FullTrust")]
public ref class PictureContentControl sealed : public ContentControlBase,
ISupportInitializeControl, ISupportInitialize
public final class PictureContentControl extends ContentControlBase implements ISupportInitializeControl, ISupportInitialize
Remarks
A PictureContentControl displays an image. You can specify the image at design time or run time, or users can click this control to select an image to insert in the document.
To get or set the image, use the Image property. By default, users cannot change the image in the PictureContentControl at run time. If you want to enable users to choose the image to display in the control, set the ShowInsertPictureIcon property to true.
Content Controls
The PictureContentControl is one of eight types of content controls that you can use to design documents and templates in Microsoft Office Word. Content controls have a user interface (UI) that has controlled input like a form. You can use content controls to prevent users from editing protected sections of the document or template, and you can also bind content controls to a data source. For more information, see Content Controls.
Examples
The following code example adds a new PictureContentControl to the beginning of the document. This example assumes that a file named picture.bmp exists in the %UserProfile%\My Documents folder (for Windows XP and earlier) or the %UserProfile%\Documents folder (for Windows Vista).
This version is for a document-level customization. To use this code, paste it into the ThisDocument class in your project, and call the AddPictureControlAtSelection method from the ThisDocument_Startup method.
Dim pictureControl1 As Microsoft.Office.Tools.Word.PictureContentControl
Dim bitmap1 As System.Drawing.Bitmap
Private Sub AddPictureControlAtSelection()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Me.Paragraphs(1).Range.Select()
pictureControl1 = Me.Controls.AddPictureContentControl("pictureControl1")
Dim imagePath As String = My.Computer.FileSystem.SpecialDirectories.MyDocuments & _
"\picture.bmp"
bitmap1 = New System.Drawing.Bitmap(imagePath, True)
pictureControl1.Image = bitmap1
End Sub
private Microsoft.Office.Tools.Word.PictureContentControl pictureControl1;
private System.Drawing.Bitmap bitmap1;
private void AddPictureControlAtSelection()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
this.Paragraphs[1].Range.Select();
pictureControl1 = this.Controls.AddPictureContentControl("pictureControl1");
string imagePath = System.Environment.GetFolderPath(
Environment.SpecialFolder.MyDocuments) + "\\picture.bmp";
bitmap1 = new System.Drawing.Bitmap(imagePath, true);
pictureControl1.Image = bitmap1;
}
This version is for an application-level add-in. To use this code, paste it into the ThisAddIn class in your project, and call the AddPictureControlAtSelection method from the ThisAddIn_Startup method.
Dim pictureControl1 As Microsoft.Office.Tools.Word.PictureContentControl
Dim bitmap1 As System.Drawing.Bitmap
Private Sub AddPictureControlAtSelection()
If Me.Application.ActiveDocument Is Nothing Then
Return
End If
Dim vstoDoc As Document = Me.Application.ActiveDocument.GetVstoObject()
vstoDoc.Paragraphs(1).Range.InsertParagraphBefore()
vstoDoc.Paragraphs(1).Range.Select()
pictureControl1 = vstoDoc.Controls.AddPictureContentControl("pictureControl1")
Dim imagePath As String = My.Computer.FileSystem.SpecialDirectories.MyDocuments & _
"\picture.bmp"
bitmap1 = New System.Drawing.Bitmap(imagePath, True)
pictureControl1.Image = bitmap1
End Sub
private Microsoft.Office.Tools.Word.PictureContentControl pictureControl1;
private System.Drawing.Bitmap bitmap1;
private void AddPictureControlAtSelection()
{
if (this.Application.ActiveDocument == null)
return;
Document vstoDoc = this.Application.ActiveDocument.GetVstoObject();
vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
vstoDoc.Paragraphs[1].Range.Select();
pictureControl1 = vstoDoc.Controls.AddPictureContentControl("pictureControl1");
string imagePath = System.Environment.GetFolderPath(
Environment.SpecialFolder.MyDocuments) + "\\picture.bmp";
bitmap1 = new System.Drawing.Bitmap(imagePath, true);
pictureControl1.Image = bitmap1;
}
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Tools.Office.RemoteComponent
Microsoft.VisualStudio.Tools.Office.RemoteBindableComponent
Microsoft.Office.Tools.Word.ContentControlBase
Microsoft.Office.Tools.Word.PictureContentControl
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Reference
Microsoft.Office.Tools.Word Namespace
Other Resources
How to: Add Content Controls to Word Documents
How to: Protect Parts of Documents by Using Content Controls
Walkthrough: Creating a Template By Using Content Controls
Walkthrough: Binding Content Controls to Custom XML Parts
Change History
Date |
History |
Reason |
|---|---|---|
July 2008 |
Added a version of the code example for an application-level add-in. |
SP1 feature change. |