Button Class

Represents a Windows Forms button that can be added to a Microsoft Office Word document.

Namespace: Microsoft.Office.Tools.Word.Controls
Assembly: Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Inheritance Hierarchy

System::Object
System::MarshalByRefObject
System.ComponentModel::Component
System.Windows.Forms::Control
System.Windows.Forms::ButtonBase
System.Windows.Forms::Button
Microsoft.Office.Tools.Word.Controls::Button

Syntax

C++

[DefaultEventAttribute("Click")]
[DefaultPropertyAttribute("Text")]
[ToolboxItemAttribute(false)]
[PermissionSetAttribute(SecurityAction::Demand, Name = "FullTrust")]
public ref class Button : Button

Properties

	Name	Description
	AccessibilityObject	(Inherited from Control.)
	AccessibleDefaultActionDescription	(Inherited from Control.)
	AccessibleDescription	(Inherited from Control.)
	AccessibleName	(Inherited from Control.)
	AccessibleRole	(Inherited from Control.)
	AllowDrop	(Inherited from Control.)
	AltHTML	This API supports the product infrastructure and is not intended to be used directly from your code.
	Anchor	(Inherited from Control.)
	AutoEllipsis	(Inherited from ButtonBase.)
	Automation	This API supports the product infrastructure and is not intended to be used directly from your code.
	AutoScrollOffset	(Inherited from Control.)
	AutoSize	(Inherited from ButtonBase.)
	AutoSizeMode	(Inherited from Button.)
	BackColor	(Inherited from ButtonBase.)
	BackgroundImage	(Inherited from Control.)
	BackgroundImageLayout	(Inherited from Control.)
	BindingContext	(Inherited from Control.)
	Bottom	Gets the distance, in points, between the bottom edge of the Button and the top edge of the document.
	Bounds	(Inherited from Control.)
	CanEnableIme	(Inherited from Control.)
	CanFocus	(Inherited from Control.)
	CanRaiseEvents	(Inherited from Control.)
	CanSelect	(Inherited from Control.)
	Capture	(Inherited from Control.)
	CausesValidation	(Inherited from Control.)
	ClientRectangle	(Inherited from Control.)
	ClientSize	(Inherited from Control.)
	CompanyName	(Inherited from Control.)
	Container	(Inherited from Component.)
	ContainsFocus	(Inherited from Control.)
	ContextMenu	(Inherited from Control.)
	ContextMenuStrip	(Inherited from Control.)
	Controls	(Inherited from Control.)
	Created	(Inherited from Control.)
	CreateParams	(Inherited from Button.)
	Cursor	(Inherited from Control.)
	DataBindings	(Inherited from Control.)
	DefaultCursor	(Inherited from Control.)
	DefaultImeMode	(Inherited from ButtonBase.)
	DefaultMargin	(Inherited from Control.)
	DefaultMaximumSize	(Inherited from Control.)
	DefaultMinimumSize	(Inherited from Control.)
	DefaultPadding	(Inherited from Control.)
	DefaultSize	(Inherited from ButtonBase.)
	DesignMode	(Inherited from Component.)
	DialogResult	(Inherited from Button.)
	DisplayRectangle	(Inherited from Control.)
	Disposing	(Inherited from Control.)
	Dock	(Inherited from Control.)
	DoubleBuffered	(Inherited from Control.)
	Enabled	(Inherited from Control.)
	Events	(Inherited from Component.)
	FlatAppearance	(Inherited from ButtonBase.)
	FlatStyle	(Inherited from ButtonBase.)
	Focused	(Inherited from Control.)
	Font	(Inherited from Control.)
	FontHeight	(Inherited from Control.)
	ForeColor	(Inherited from Control.)
	Handle	(Inherited from Control.)
	HasChildren	(Inherited from Control.)
	Height	Gets or sets the height of the Button.
	Image	(Inherited from ButtonBase.)
	ImageAlign	(Inherited from ButtonBase.)
	ImageIndex	(Inherited from ButtonBase.)
	ImageKey	(Inherited from ButtonBase.)
	ImageList	(Inherited from ButtonBase.)
	ImeMode	(Inherited from Control.)
	ImeModeBase	(Inherited from Control.)
	InlineShape	Gets the underlying InlineShape of the Button.
	InvokeRequired	(Inherited from Control.)
	IsAccessible	(Inherited from Control.)
	IsDefault	(Inherited from ButtonBase.)
	IsDisposed	(Inherited from Control.)
	IsHandleCreated	(Inherited from Control.)
	IsMirrored	(Inherited from Control.)
	LayoutEngine	(Inherited from Control.)
	Left	Gets or sets the distance, in points, between the left edge of the Button and the left edge of the document.
	Location	(Inherited from Control.)
	Margin	(Inherited from Control.)
	MaximumSize	(Inherited from Control.)
	MinimumSize	(Inherited from Control.)
	Name	(Inherited from Control.)
	Padding	(Inherited from Control.)
	Parent	(Inherited from Control.)
	PreferredSize	(Inherited from Control.)
	ProductName	(Inherited from Control.)
	ProductVersion	(Inherited from Control.)
	RecreatingHandle	(Inherited from Control.)
	Region	(Inherited from Control.)
	RenderRightToLeft	(Inherited from Control.)
	ResizeRedraw	(Inherited from Control.)
	Right	Gets the distance, in points, between the right edge of the Button and the left edge of the document.
	RightToLeft	(Inherited from Control.)
	ScaleChildren	(Inherited from Control.)
	Shape	Gets the underlying Shape of the Button.
	ShowFocusCues	(Inherited from Control.)
	ShowKeyboardCues	(Inherited from Control.)
	Site	(Inherited from Control.)
	Size	(Inherited from Control.)
	TabIndex	(Inherited from Control.)
	TabStop	(Inherited from Control.)
	Tag	(Inherited from Control.)
	Text	(Inherited from ButtonBase.)
	TextAlign	(Inherited from ButtonBase.)
	TextImageRelation	(Inherited from ButtonBase.)
	Top	Gets or sets the distance, in points, between the top edge of the Button and the top edge of the document.
	TopLevelControl	(Inherited from Control.)
	UseCompatibleTextRendering	(Inherited from ButtonBase.)
	UseMnemonic	(Inherited from ButtonBase.)
	UseVisualStyleBackColor	(Inherited from ButtonBase.)
	UseWaitCursor	(Inherited from Control.)
	Visible	(Inherited from Control.)
	Width	Gets or sets the width of the Button in points.

Methods

	Name	Description
	AccessibilityNotifyClients(AccessibleEvents, Int32)	(Inherited from Control.)
	AccessibilityNotifyClients(AccessibleEvents, Int32, Int32)	(Inherited from Control.)
	Activate()	Activates the Button.
	BeginInvoke(Delegate^)	(Inherited from Control.)
	BeginInvoke(Delegate^, array<Object^>^)	(Inherited from Control.)
	BringToFront()	(Inherited from Control.)
	Contains(Control^)	(Inherited from Control.)
	CreateAccessibilityInstance()	(Inherited from ButtonBase.)
	CreateControl()	(Inherited from Control.)
	CreateControlsInstance()	(Inherited from Control.)
	CreateGraphics()	(Inherited from Control.)
	CreateHandle()	(Inherited from Control.)
	CreateObjRef(Type^)	(Inherited from MarshalByRefObject.)
	DefWndProc(Message%)	(Inherited from Control.)
	Delete()	Deletes a dynamically created Button from the document and removes it from the ControlCollection.
	DestroyHandle()	(Inherited from Control.)
	Dispose()	(Inherited from Component.)
	Dispose(Boolean)	(Inherited from ButtonBase.)
	DoDragDrop(Object^, DragDropEffects)	(Inherited from Control.)
	DrawToBitmap(Bitmap^, Rectangle)	(Inherited from Control.)
	EndInvoke(IAsyncResult^)	(Inherited from Control.)
	Equals(Object^)	(Inherited from Object.)
	Finalize()	(Inherited from Component.)
	FindForm()	(Inherited from Control.)
	Focus()	(Inherited from Control.)
	GetAccessibilityObjectById(Int32)	(Inherited from Control.)
	GetAutoSizeMode()	(Inherited from Control.)
	GetChildAtPoint(Point)	(Inherited from Control.)
	GetChildAtPoint(Point, GetChildAtPointSkip)	(Inherited from Control.)
	GetContainerControl()	(Inherited from Control.)
	GetHashCode()	(Inherited from Object.)
	GetLifetimeService()	(Inherited from MarshalByRefObject.)
	GetNextControl(Control^, Boolean)	(Inherited from Control.)
	GetPreferredSize(Size)	(Inherited from ButtonBase.)
	GetScaledBounds(Rectangle, SizeF, BoundsSpecified)	(Inherited from Control.)
	GetService(Type^)	(Inherited from Component.)
	GetStyle(ControlStyles)	(Inherited from Control.)
	GetTopLevel()	(Inherited from Control.)
	GetType()	(Inherited from Object.)
	Hide()	(Inherited from Control.)
	InitializeLifetimeService()	(Inherited from MarshalByRefObject.)
	InitLayout()	(Inherited from Control.)
	Invalidate()	(Inherited from Control.)
	Invalidate(Boolean)	(Inherited from Control.)
	Invalidate(Rectangle)	(Inherited from Control.)
	Invalidate(Rectangle, Boolean)	(Inherited from Control.)
	Invalidate(Region^)	(Inherited from Control.)
	Invalidate(Region^, Boolean)	(Inherited from Control.)
	Invoke(Delegate^)	(Inherited from Control.)
	Invoke(Delegate^, array<Object^>^)	(Inherited from Control.)
	InvokeGotFocus(Control^, EventArgs^)	(Inherited from Control.)
	InvokeLostFocus(Control^, EventArgs^)	(Inherited from Control.)
	InvokeOnClick(Control^, EventArgs^)	(Inherited from Control.)
	InvokePaint(Control^, PaintEventArgs^)	(Inherited from Control.)
	InvokePaintBackground(Control^, PaintEventArgs^)	(Inherited from Control.)
	IsInputChar(Char)	(Inherited from Control.)
	IsInputKey(Keys)	(Inherited from Control.)
	MemberwiseClone()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	NotifyDefault(Boolean)	(Inherited from Button.)
	NotifyInvalidate(Rectangle)	(Inherited from Control.)
	OnAutoSizeChanged(EventArgs^)	(Inherited from Control.)
	OnBackColorChanged(EventArgs^)	(Inherited from Control.)
	OnBackgroundImageChanged(EventArgs^)	(Inherited from Control.)
	OnBackgroundImageLayoutChanged(EventArgs^)	(Inherited from Control.)
	OnBindingContextChanged(EventArgs^)	(Inherited from Control.)
	OnCausesValidationChanged(EventArgs^)	(Inherited from Control.)
	OnChangeUICues(UICuesEventArgs^)	(Inherited from Control.)
	OnClick(EventArgs^)	(Inherited from Button.)
	OnClientSizeChanged(EventArgs^)	(Inherited from Control.)
	OnContextMenuChanged(EventArgs^)	(Inherited from Control.)
	OnContextMenuStripChanged(EventArgs^)	(Inherited from Control.)
	OnControlAdded(ControlEventArgs^)	(Inherited from Control.)
	OnControlRemoved(ControlEventArgs^)	(Inherited from Control.)
	OnCreateControl()	(Inherited from Control.)
	OnCursorChanged(EventArgs^)	(Inherited from Control.)
	OnDockChanged(EventArgs^)	(Inherited from Control.)
	OnDoubleClick(EventArgs^)	(Inherited from Control.)
	OnDragDrop(DragEventArgs^)	(Inherited from Control.)
	OnDragEnter(DragEventArgs^)	(Inherited from Control.)
	OnDragLeave(EventArgs^)	(Inherited from Control.)
	OnDragOver(DragEventArgs^)	(Inherited from Control.)
	OnEnabledChanged(EventArgs^)	(Inherited from ButtonBase.)
	OnEnter(EventArgs^)	(Inherited from Control.)
	OnFontChanged(EventArgs^)	(Inherited from Button.)
	OnForeColorChanged(EventArgs^)	(Inherited from Control.)
	OnGiveFeedback(GiveFeedbackEventArgs^)	(Inherited from Control.)
	OnGotFocus(EventArgs^)	(Inherited from ButtonBase.)
	OnHandleCreated(EventArgs^)	(Inherited from Control.)
	OnHandleDestroyed(EventArgs^)	(Inherited from Control.)
	OnHelpRequested(HelpEventArgs^)	(Inherited from Control.)
	OnImeModeChanged(EventArgs^)	(Inherited from Control.)
	OnInvalidated(InvalidateEventArgs^)	(Inherited from Control.)
	OnKeyDown(KeyEventArgs^)	(Inherited from ButtonBase.)
	OnKeyPress(KeyPressEventArgs^)	(Inherited from Control.)
	OnKeyUp(KeyEventArgs^)	(Inherited from ButtonBase.)
	OnLayout(LayoutEventArgs^)	(Inherited from Control.)
	OnLeave(EventArgs^)	(Inherited from Control.)
	OnLocationChanged(EventArgs^)	(Inherited from Control.)
	OnLostFocus(EventArgs^)	(Inherited from ButtonBase.)
	OnMarginChanged(EventArgs^)	(Inherited from Control.)
	OnMouseCaptureChanged(EventArgs^)	(Inherited from Control.)
	OnMouseClick(MouseEventArgs^)	(Inherited from Control.)
	OnMouseDoubleClick(MouseEventArgs^)	(Inherited from Control.)
	OnMouseDown(MouseEventArgs^)	(Inherited from ButtonBase.)
	OnMouseEnter(EventArgs^)	(Inherited from Button.)
	OnMouseHover(EventArgs^)	(Inherited from Control.)
	OnMouseLeave(EventArgs^)	(Inherited from Button.)
	OnMouseMove(MouseEventArgs^)	(Inherited from ButtonBase.)
	OnMouseUp(MouseEventArgs^)	(Inherited from Button.)
	OnMouseWheel(MouseEventArgs^)	(Inherited from Control.)
	OnMove(EventArgs^)	(Inherited from Control.)
	OnNotifyMessage(Message)	(Inherited from Control.)
	OnPaddingChanged(EventArgs^)	(Inherited from Control.)
	OnPaint(PaintEventArgs^)	(Inherited from ButtonBase.)
	OnPaintBackground(PaintEventArgs^)	(Inherited from Control.)
	OnParentBackColorChanged(EventArgs^)	(Inherited from Control.)
	OnParentBackgroundImageChanged(EventArgs^)	(Inherited from Control.)
	OnParentBindingContextChanged(EventArgs^)	(Inherited from Control.)
	OnParentChanged(EventArgs^)	(Inherited from ButtonBase.)
	OnParentCursorChanged(EventArgs^)	(Inherited from Control.)
	OnParentEnabledChanged(EventArgs^)	(Inherited from Control.)
	OnParentFontChanged(EventArgs^)	(Inherited from Control.)
	OnParentForeColorChanged(EventArgs^)	(Inherited from Control.)
	OnParentRightToLeftChanged(EventArgs^)	(Inherited from Control.)
	OnParentVisibleChanged(EventArgs^)	(Inherited from Control.)
	OnPreviewKeyDown(PreviewKeyDownEventArgs^)	(Inherited from Control.)
	OnPrint(PaintEventArgs^)	(Inherited from Control.)
	OnQueryContinueDrag(QueryContinueDragEventArgs^)	(Inherited from Control.)
	OnRegionChanged(EventArgs^)	(Inherited from Control.)
	OnResize(EventArgs^)	(Inherited from Control.)
	OnRightToLeftChanged(EventArgs^)	(Inherited from Control.)
	OnSizeChanged(EventArgs^)	(Inherited from Control.)
	OnStyleChanged(EventArgs^)	(Inherited from Control.)
	OnSystemColorsChanged(EventArgs^)	(Inherited from Control.)
	OnTabIndexChanged(EventArgs^)	(Inherited from Control.)
	OnTabStopChanged(EventArgs^)	(Inherited from Control.)
	OnTextChanged(EventArgs^)	(Inherited from Button.)
	OnValidated(EventArgs^)	(Inherited from Control.)
	OnValidating(CancelEventArgs^)	(Inherited from Control.)
	OnVisibleChanged(EventArgs^)	(Inherited from ButtonBase.)
	PerformClick()	(Inherited from Button.)
	PerformLayout()	(Inherited from Control.)
	PerformLayout(Control^, String^)	(Inherited from Control.)
	PointToClient(Point)	(Inherited from Control.)
	PointToScreen(Point)	(Inherited from Control.)
	PreProcessControlMessage(Message%)	(Inherited from Control.)
	PreProcessMessage(Message%)	(Inherited from Control.)
	ProcessCmdKey(Message%, Keys)	(Inherited from Control.)
	ProcessDialogChar(Char)	(Inherited from Control.)
	ProcessDialogKey(Keys)	(Inherited from Control.)
	ProcessKeyEventArgs(Message%)	(Inherited from Control.)
	ProcessKeyMessage(Message%)	(Inherited from Control.)
	ProcessKeyPreview(Message%)	(Inherited from Control.)
	ProcessMnemonic(Char)	(Inherited from Button.)
	RaiseDragEvent(Object^, DragEventArgs^)	(Inherited from Control.)
	RaiseKeyEvent(Object^, KeyEventArgs^)	(Inherited from Control.)
	RaiseMouseEvent(Object^, MouseEventArgs^)	(Inherited from Control.)
	RaisePaintEvent(Object^, PaintEventArgs^)	(Inherited from Control.)
	RecreateHandle()	(Inherited from Control.)
	RectangleToClient(Rectangle)	(Inherited from Control.)
	RectangleToScreen(Rectangle)	(Inherited from Control.)
	Refresh()	(Inherited from Control.)
	ResetFlagsandPaint()	(Inherited from ButtonBase.)
	ResetMouseEventArgs()	(Inherited from Control.)
	ResetText()	(Inherited from Control.)
	ResumeLayout()	(Inherited from Control.)
	ResumeLayout(Boolean)	(Inherited from Control.)
	RtlTranslateAlignment(ContentAlignment)	(Inherited from Control.)
	RtlTranslateAlignment(HorizontalAlignment)	(Inherited from Control.)
	RtlTranslateAlignment(LeftRightAlignment)	(Inherited from Control.)
	RtlTranslateContent(ContentAlignment)	(Inherited from Control.)
	RtlTranslateHorizontal(HorizontalAlignment)	(Inherited from Control.)
	RtlTranslateLeftRight(LeftRightAlignment)	(Inherited from Control.)
	Scale(SizeF)	(Inherited from Control.)
	ScaleControl(SizeF, BoundsSpecified)	(Inherited from Control.)
	Select()	Selects the Button.
	Select(Boolean, Boolean)	(Inherited from Control.)
	SelectNextControl(Control^, Boolean, Boolean, Boolean, Boolean)	(Inherited from Control.)
	SendToBack()	(Inherited from Control.)
	SetAutoSizeMode(AutoSizeMode)	(Inherited from Control.)
	SetBounds(Int32, Int32, Int32, Int32)	(Inherited from Control.)
	SetBounds(Int32, Int32, Int32, Int32, BoundsSpecified)	(Inherited from Control.)
	SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified)	This API supports the product infrastructure and is not intended to be used directly from your code. (Overrides Control::SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified).)
	SetClientSizeCore(Int32, Int32)	(Inherited from Control.)
	SetStyle(ControlStyles, Boolean)	(Inherited from Control.)
	SetTopLevel(Boolean)	(Inherited from Control.)
	SetVisibleCore(Boolean)	This API supports the product infrastructure and is not intended to be used directly from your code. (Overrides Control::SetVisibleCore(Boolean).)
	Show()	(Inherited from Control.)
	SizeFromClientSize(Size)	(Inherited from Control.)
	SuspendLayout()	(Inherited from Control.)
	ToString()	(Inherited from Button.)
	Update()	(Inherited from Control.)
	UpdateBounds()	(Inherited from Control.)
	UpdateBounds(Int32, Int32, Int32, Int32)	(Inherited from Control.)
	UpdateBounds(Int32, Int32, Int32, Int32, Int32, Int32)	(Inherited from Control.)
	UpdateStyles()	(Inherited from Control.)
	UpdateZOrder()	(Inherited from Control.)
	WndProc(Message%)	(Inherited from Button.)

Events

	Name	Description
	AutoSizeChanged	(Inherited from ButtonBase.)
	BackColorChanged	(Inherited from Control.)
	BackgroundImageChanged	(Inherited from Control.)
	BackgroundImageLayoutChanged	(Inherited from Control.)
	BindingContextChanged	(Inherited from Control.)
	CausesValidationChanged	(Inherited from Control.)
	ChangeUICues	(Inherited from Control.)
	Click	(Inherited from Control.)
	ClientSizeChanged	(Inherited from Control.)
	ContextMenuChanged	(Inherited from Control.)
	ContextMenuStripChanged	(Inherited from Control.)
	ControlAdded	(Inherited from Control.)
	ControlRemoved	(Inherited from Control.)
	CursorChanged	(Inherited from Control.)
	Disposed	(Inherited from Component.)
	DockChanged	(Inherited from Control.)
	DoubleClick	(Inherited from Button.)
	DragDrop	(Inherited from Control.)
	DragEnter	(Inherited from Control.)
	DragLeave	(Inherited from Control.)
	DragOver	(Inherited from Control.)
	EnabledChanged	(Inherited from Control.)
	Enter	(Inherited from Control.)
	FontChanged	(Inherited from Control.)
	ForeColorChanged	(Inherited from Control.)
	GiveFeedback	(Inherited from Control.)
	GotFocus	(Inherited from Control.)
	HandleCreated	(Inherited from Control.)
	HandleDestroyed	(Inherited from Control.)
	HelpRequested	(Inherited from Control.)
	ImeModeChanged	(Inherited from Control.)
	Invalidated	(Inherited from Control.)
	KeyDown	(Inherited from Control.)
	KeyPress	(Inherited from Control.)
	KeyUp	(Inherited from Control.)
	Layout	(Inherited from Control.)
	Leave	(Inherited from Control.)
	LocationChanged	(Inherited from Control.)
	LostFocus	(Inherited from Control.)
	MarginChanged	(Inherited from Control.)
	MouseCaptureChanged	(Inherited from Control.)
	MouseClick	(Inherited from Control.)
	MouseDoubleClick	(Inherited from Button.)
	MouseDown	(Inherited from Control.)
	MouseEnter	(Inherited from Control.)
	MouseHover	(Inherited from Control.)
	MouseLeave	(Inherited from Control.)
	MouseMove	(Inherited from Control.)
	MouseUp	(Inherited from Control.)
	MouseWheel	(Inherited from Control.)
	Move	(Inherited from Control.)
	PaddingChanged	(Inherited from Control.)
	Paint	(Inherited from Control.)
	ParentChanged	(Inherited from Control.)
	PreviewKeyDown	(Inherited from Control.)
	QueryAccessibilityHelp	(Inherited from Control.)
	QueryContinueDrag	(Inherited from Control.)
	RegionChanged	(Inherited from Control.)
	Resize	(Inherited from Control.)
	RightToLeftChanged	(Inherited from Control.)
	SizeChanged	(Inherited from Control.)
	StyleChanged	(Inherited from Control.)
	SystemColorsChanged	(Inherited from Control.)
	TabIndexChanged	(Inherited from Control.)
	TabStopChanged	(Inherited from Control.)
	TextChanged	(Inherited from Control.)
	Validated	(Inherited from Control.)
	Validating	(Inherited from Control.)
	VisibleChanged	(Inherited from Control.)

Explicit Interface Implementations

	Name	Description
	IDropTarget::OnDragDrop(DragEventArgs^)	(Inherited from Control.)
	IDropTarget::OnDragEnter(DragEventArgs^)	(Inherited from Control.)
	IDropTarget::OnDragLeave(EventArgs^)	(Inherited from Control.)
	IDropTarget::OnDragOver(DragEventArgs^)	(Inherited from Control.)

The Microsoft.Office.Tools.Word.Controls::Button is different from a System.Windows.Forms::Button. The Microsoft.Office.Tools.Word.Controls::Button has additional members that enable it to be added to a Word document and that give it additional methods and properties.

Do not use the constructor to create a new Button. Use the AddButton method to add a new Button to a document.

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.