ToggleButtonField Class

A ShapeField which can display an image corresponding the selected state

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Modeling.Diagrams.ShapeField
    Microsoft.VisualStudio.Modeling.Diagrams.ToggleButtonField
      Microsoft.VisualStudio.Modeling.Diagrams.ChevronButtonField
      Microsoft.VisualStudio.Modeling.Diagrams.PlusMinusButtonField

Namespace:  Microsoft.VisualStudio.Modeling.Diagrams
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Diagrams.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.10.0.dll)

Syntax

'Declaração
Public MustInherit Class ToggleButtonField _
    Inherits ShapeField

public abstract class ToggleButtonField : ShapeField

public ref class ToggleButtonField abstract : public ShapeField

[<AbstractClass>]
type ToggleButtonField =  
    class
        inherit ShapeField
    end

public abstract class ToggleButtonField extends ShapeField

The ToggleButtonField type exposes the following members.

Constructors

	Name	Description
	ToggleButtonField	Initializes a new instance of the ToggleButtonField class

Top

Properties

	Name	Description
	AnchoringBehavior	Describes how the content of the field should position and size itself in relation to the parent ShapeElement. (Inherited from ShapeField.)
	DefaultAccessibleDescription	Gets or sets the default accessible description. (Inherited from ShapeField.)
	DefaultAccessibleName	Gets or sets the default name of the shape field for the accessible object. (Inherited from ShapeField.)
	DefaultAccessibleState	Gets the default state of the shape field for the accessible object. (Inherited from ShapeField.)
	DefaultBackgroundBrushId	Gets or sets the ID of the default brush to paint the background of the shape field. (Inherited from ShapeField.)
	DefaultFocusable	Gets the shape field and verifies whether it can receive focus, or gives the shape field the ability to receive focus. (Inherited from ShapeField.)
	DefaultInactiveSelectedBackgroundBrushId	Gets or sets the ID of the default background brush for the shape field. (Inherited from ShapeField.)
	DefaultPenId	Gets or sets the ID of the default pen to use for the shape field. (Inherited from ShapeField.)
	DefaultReflectParentFocusedState	Gets the child shape field and verifies whether it should receive focus when its parent shape receives focus or sets the ability to reflect the focus state of its parent shape. (Inherited from ShapeField.)
	DefaultReflectParentSelectedState	Gets the child shape field and verifies whether it should be selected when its parent shape is selected or sets the ability to reflect the selection state of its parent shape. (Inherited from ShapeField.)
	DefaultSelectable	Gets the shape field and verifies whether it can be selected by default or sets the default selection state of the shape field. (Inherited from ShapeField.)
	DefaultSelectedBackgroundBrushId	Gets or sets the ID of the default background brush for the shape field. (Inherited from ShapeField.)
	DefaultUnscaled	Gets or sets a value indicating whether the image should be drawn unscaled with regards to the bounds of this field or the image should be scaled to fit the bounds.
	DefaultVisibility	Gets the shape field and verifies whether it appears by default or sets the default visibility of the shape field. (Inherited from ShapeField.)
	Name	Gets the name of the shape field. (Inherited from ShapeField.)

Top

Methods

	Name	Description
	AccessibleDoDefaultAction	Performs the default action for the accessible object. (Inherited from ShapeField.)
	AllowInPlaceEditorAutoSize	Enables the in-place editor to be automatically sized in the shape field. (Inherited from ShapeField.)
	AssociateValueWith(Store, AssociatedPropertyInfo)	Associates the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
	AssociateValueWith(Store, Guid)	Associates the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
	AssociateValueWith(Store, Guid, AssociatedPropertyInfo)	Associates the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
	AssociateVisibilityWith(Store, AssociatedPropertyInfo)	Associates the visibility of the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
	AssociateVisibilityWith(Store, Guid)	Associates the visibility of the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
	AssociateVisibilityWith(Store, Guid, AssociatedPropertyInfo)	Associates the visibility of the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
	CanEditValue	Gets the shape field and verifies whether it can be edited. (Inherited from ShapeField.)
	ChangeState	Change the state of the toggle button
	CommitPendingEdit	Commits the pending edit. (Inherited from ShapeField.)
	CreateToggleButtonEventArgs	Create an instance of the class responsible for toggle button event arguments
	DoHitTest	Performs a hit test on a specified point in the diagram to determine whether the point is in the bounds of the shape field. (Inherited from ShapeField.)
	DoKeyboardNavigation	Navigates in the shape field by using the keyboard. (Inherited from ShapeField.)
	DoPaint	Draws the contents of the ShapeField. (Overrides ShapeField.DoPaint(DiagramPaintEventArgs, ShapeElement).)
	EditValue(ShapeElement, DiagramClientView)	Opens the in-place editor for the shape field. (Inherited from ShapeField.)
	EditValue(ShapeElement, DiagramClientView, PointD)	Opens the in-place editor for the shape field. (Inherited from ShapeField.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FindFirstChild	Locates the first child shape field in the parent shape field. (Inherited from ShapeField.)
	FindLastChild	Locates the last child shape field in the parent shape field. (Inherited from ShapeField.)
	FindNextChild	Locates the next child shape field in the parent shape field. (Inherited from ShapeField.)
	FindNextInChildSubFields	Locates the next child shape field in the navigation sequence. (Inherited from ShapeField.)
	FindPreviousChild	Locates the previous child shape field in the parent shape field. (Inherited from ShapeField.)
	FindPreviousInChildSubFields	Locates the previous child shape field in the navigation sequence. (Inherited from ShapeField.)
	Focused	Gets the shape field and verifies whether it has focus. (Inherited from ShapeField.)
	GetAccessibilityObject	Gets the accessibility object that is assigned to the shape field. (Inherited from ShapeField.)
	GetAccessibleChild	Gets the Accessibility object for the child shape field. (Inherited from ShapeField.)
	GetAccessibleChildCount	Gets the number of Accessibility objects that are assigned to the parent shape field and its child shape fields. (Inherited from ShapeField.)
	GetAccessibleDefaultActionDescription	Gets the default purpose of the shape field for the accessible object. (Inherited from ShapeField.)
	GetAccessibleDescription	Gets the description of the shape field for the accessible object. (Inherited from ShapeField.)
	GetAccessibleHelp	Gets the shape field Help for the accessible object. (Inherited from ShapeField.)
	GetAccessibleHelpTopicFileName	Gets a topic in the Help for the accessible object. (Inherited from ShapeField.)
	GetAccessibleHelpTopicId	Gets the ID that is assigned to the Help topic for the accessible object. (Inherited from ShapeField.)
	GetAccessibleName	Gets the name of the shape field for the accessible object. (Inherited from ShapeField.)
	GetAccessibleRole	Gets the role of the shape field for the accessible object. (Inherited from ShapeField.)
	GetAccessibleState	Gets the state of the shape field for the accessible object. (Inherited from ShapeField.)
	GetAccessibleValue	Gets the value in the shape field for the accessible object. (Inherited from ShapeField.)
	GetActiveInPlaceEditor	Gets the in-place editor that is active. (Inherited from ShapeField.)
	GetBackgroundBrush	Gets the brush that draws the background for the shape element to which this shape field is assigned. (Inherited from ShapeField.)
	GetBackgroundBrushId	Gets the ID of the brush that draws the background for the shape element to which this shape field is assigned. (Inherited from ShapeField.)
	GetBitmap	Gets a metafile
	GetBounds	Gets the bounds for the shape field. (Inherited from ShapeField.)
	GetButtonImage	Provides the image for the current state of the button
	GetCursor	Gets the pointer that appears when the mouse is pointing to the shape field. (Inherited from ShapeField.)
	GetFocusable	Gets the shape field and verifies whether it can receive focus. (Inherited from ShapeField.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetInPlaceEditorBounds	Gets the bounds for the in-place editor. (Inherited from ShapeField.)
	GetMaximumInPlaceEditorSize	Gets the maximum bounds for the in-place editor. (Inherited from ShapeField.)
	GetMetafile	Gets a metafile
	GetMinimumInPlaceEditorSize	Gets the minimum bounds for the in-place editor. (Inherited from ShapeField.)
	GetMinimumSize	Returns the minimum size of the ImageField, which is the size of the image to be displayed, or the minimum size specified in the AnchoringBehavior, whichever is larger. If the shape field is unscaled, then the AnchoringBehavior size is always used. (Overrides ShapeField.GetMinimumSize(ShapeElement).)
	GetPen	Gets the pen that draws the shape element to which the shape field is assigned. (Inherited from ShapeField.)
	GetPenId	Gets the ID of the pen that draws the shape element to which the shape field is assigned. (Inherited from ShapeField.)
	GetPotentialMouseAction	Retrieves a mouse action that should be made active on the next MouseDown event if the mouse is over the specified point. (Overrides ShapeField.GetPotentialMouseAction(MouseButtons, PointD, DiagramHitTestInfo).)
	GetSelectable	Gets the shape field and verifies whether it can be selected. (Inherited from ShapeField.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUnscaled	Gets whether the button image should be drawn unscaled or not.
	GetValue	Gets the value in the shape field. (Inherited from ShapeField.)
	GetValueDomainPropertyInfo	Gets the domain property that is assigned to the value in the shape field. (Inherited from ShapeField.)
	GetVisible	Gets the shape field and verifies whether it appears. (Inherited from ShapeField.)
	HasFocusedAppearance	Gets the shape field and verifies whether it should appear to have the focus. (Inherited from ShapeField.)
	HasPendingEdit	Gets the shape field and verifies whether its in-place editor is active and a change is pending. (Inherited from ShapeField.)
	HasSelectedAppearance	Gets the shape field and verifies whether it appears to be selected. (Inherited from ShapeField.)
	IsNavigationKey(Char)	Gets the key that the user pressed and verifies whether it can be used to navigate between shape fields. (Inherited from ShapeField.)
	IsNavigationKey(Keys)	Gets the keys that the user pressed and verifies whether they can be used to navigate between shape fields. (Inherited from ShapeField.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NavigateAscend	Moves the focus to the previous shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
	NavigateDescend	Moves the focus to the next shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
	NavigateToFirst	Moves the focus to the first shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
	NavigateToLast	Moves the focus to the last shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
	NavigateToNext	Moves the focus to the next shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
	NavigateToPrevious	Moves the focus to the previous shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
	OnBeginEdit	Alerts listeners when in-place editing has begun. (Inherited from ShapeField.)
	OnClick	Alerts listeners when the user has clicked a shape field. (Inherited from ShapeField.)
	OnDoubleClick	Alerts listeners when the user has double-clicked a shape field. (Inherited from ShapeField.)
	OnEndEdit	Alerts listeners when in-place editing has completed. (Inherited from ShapeField.)
	OnKeyDown	Alerts listeners when the user has held down a key when pointing to a shape field. (Inherited from ShapeField.)
	OnKeyPress	Alerts listeners when the user has pressed a key when pointing to a shape field. (Inherited from ShapeField.)
	OnKeyUp	Alerts listeners when the user has released a key when pointing to a shape field. (Inherited from ShapeField.)
	OnMouseDown	Alerts listeners when the user is holding down the mouse over a shape field. (Inherited from ShapeField.)
	OnMouseMove	Alerts listeners when the mouse has been moved over a shape field. (Inherited from ShapeField.)
	OnMouseUp	Handles mouse click on the button (Overrides ShapeField.OnMouseUp(DiagramMouseEventArgs).)
	OnMouseWheel	Alerts listeners when the mouse has been rotated over a shape field. (Inherited from ShapeField.)
	Selected	Gets the shape field and verifies whether it is selected. (Inherited from ShapeField.)
	SetSelectionRange	Sets the selection to a range of child shape fields. (Inherited from ShapeField.)
	SetValue	Assigns the specified value to a shape field. (Inherited from ShapeField.)
	SetVisible	Sets the visibility of the shape field. (Inherited from ShapeField.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	ToggleButtonStateChanging

Top

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.VisualStudio.Modeling.Diagrams Namespace