ShapeField Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Modeling.Diagrams

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.15.0.dll

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.dll

Package:: Microsoft.VisualStudio.Modeling.Sdk.Diagrams v17.10.40171

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines the base class for shape fields, which are components of a ShapeElement that are capable of drawing and editing. ShapeFields are analogous to Controls on a Form.

public ref class ShapeField abstract

public abstract class ShapeField

type ShapeField = class

Public MustInherit Class ShapeField

Inheritance: Object
ShapeField

Derived: Microsoft.VisualStudio.Modeling.Diagrams.AreaField

Microsoft.VisualStudio.Modeling.Diagrams.ImageField

Microsoft.VisualStudio.Modeling.Diagrams.ListField

Microsoft.VisualStudio.Modeling.Diagrams.ShapeAutoInvalidator

Microsoft.VisualStudio.Modeling.Diagrams.TextField

More…

Remarks

If you want to display items such as text or images within a ShapeElement, instantiate ShapeField-derived classes such as TextField or ImageField.

Constructors

ShapeField(String)

Initializes a new instance of the ShapeField class.

Properties

AnchoringBehavior	Gets the AnchoringBehavior for this ShapeField.
DefaultAccessibleDescription	Gets or sets the default accessible description.
DefaultAccessibleName	Gets or sets the default accessible name.
DefaultAccessibleState	Gets or sets the default accessible state.
DefaultBackgroundBrushId	Gets or sets the id of the default background brush to use for this ShapeField.
DefaultFocusable	Gets or sets a value indicating whether the ShapeField can receive focus by default.
DefaultInactiveSelectedBackgroundBrushId	Gets or sets the id of the default background brush to use for this ShapeField.
DefaultPenId	Gets or sets the id of the default pen to use for this ShapeField.
DefaultReflectParentFocusedState	Gets or sets a value indicating whether this field should show the focused state of its parent.
DefaultReflectParentSelectedState	Gets or sets a value indicating whether this field should show the selected state of its parent.
DefaultSelectable	Gets or sets a value indicating whether the ShapeField can be selected by default.
DefaultSelectedBackgroundBrushId	Gets or sets the id of the default background brush to use for this ShapeField.
DefaultVisibility	Gets or sets a value indicating whether the ShapeField is visible by default.
Name	Gets the unique identifier for this ShapeField.

Methods

AccessibleDoDefaultAction(ShapeElement)	Performs the default action associated with this accessible object.
AllowInPlaceEditorAutoSize(ShapeElement)	Returns a Boolean value indicating whether in-place editor should be allowed to size automatically. Default is false.
AssociateValueWith(Store, AssociatedPropertyInfo)	Associates this shape field's value with a domain property on the ShapeElement. Use this method when the domain property is a proxy for another property.
AssociateValueWith(Store, Guid, AssociatedPropertyInfo)	Associates this shape field's value with a domain property on the ShapeElement, when the shape is mapped to an instance of the given domain class. Use this method when there are multiple domain classes that this shape field can be mapped to.
AssociateValueWith(Store, Guid)	Associates this shape field's value with a domain property on the ShapeElement. Use this method when the domain property is a proxy for another property.
AssociateVisibilityWith(Store, AssociatedPropertyInfo)	Associates this shape field's visibility with a domain property on the ShapeElement.
AssociateVisibilityWith(Store, Guid, AssociatedPropertyInfo)	Associates this shape field's visibility with a domain property on the ShapeElement, when the shape is mapped to an instance of the given domain class. Use this method when there are multiple domain classes that this shape field can be mapped to.
AssociateVisibilityWith(Store, Guid)	Associates this shape field's visibility with a domain property on the ShapeElement.
CanEditValue(ShapeElement, DiagramClientView)	Returns a value indicating whether the value of this field can be edited.
CommitPendingEdit(ShapeElement, DiagramClientView)	Commits the pending edit.
DoHitTest(PointD, ShapeElement, DiagramHitTestInfo)	Gets a value indicating whether the specified point is within the bounds of the ShapeField.
DoKeyboardNavigation(Keys, DiagramClientView, DiagramItem)	Calls the appropriate navigation method on the shape field.
DoPaint(DiagramPaintEventArgs, ShapeElement)	Draws the shape field.
EditValue(ShapeElement, DiagramClientView, PointD)	Invokes the in-place editor, setting the caret using the specified mouse position.
EditValue(ShapeElement, DiagramClientView)	Invokes the in-place editor.
FindFirstChild(ShapeElement, Boolean)	Called by this ShapeField to get its first child subfield in the navigation sequence.
FindLastChild(ShapeElement, Boolean)	Called by this ShapeField to get its last subfield in the navigation sequence.
FindNextChild(DiagramItem, Boolean)	Called by the ShapeSubField to get the next sibling item following it in the navigation sequence.
FindNextInChildSubFields(ShapeElement, DiagramItem, Boolean)	Finds this ShapeField's next child subfield in the navigation sequence.
FindPreviousChild(DiagramItem, Boolean)	Called by the ShapeSubField to get the next sibling item preceding it in the navigation sequence.
FindPreviousInChildSubFields(ShapeElement, DiagramItem, Boolean)	Finds this ShapeField's previous child subfield in the navigation sequence.
Focused(ShapeElement, DiagramClientView)	Gets a value indicating whether the ShapeField has the focus.
GetAccessibilityObject(ShapeElement, DiagramClientView)	Gets the AccessibleObject assigned to the field.
GetAccessibleChild(ShapeElement, Int32)	Retrieves the accessible child subfield corresponding to the specified index.
GetAccessibleChildCount(ShapeElement)	Retrieves the number of accessible children belonging to this ShapeField.
GetAccessibleDefaultActionDescription(ShapeElement)	Gets a string that describes the default action of the object. Not all objects have a default action.
GetAccessibleDescription(ShapeElement)	Returns the accessible description.
GetAccessibleHelp(ShapeElement)	Gets a description of what the object does or how the object is used.
GetAccessibleHelpTopicFileName(ShapeElement)	Gets the path to the Help file associated with this accessible object.
GetAccessibleHelpTopicId(ShapeElement)	Gets an identifier for a Help topic identifier associated with this accessible object.
GetAccessibleName(ShapeElement)	Returns the accessible name.
GetAccessibleRole(ShapeElement)	Retrieves the accessible role of this ShapeField.
GetAccessibleState(ShapeElement, DiagramClientView)	Retrieves the accessible state of this ShapeField.
GetAccessibleValue(ShapeElement)	Returns the accessible value.
GetActiveInPlaceEditor(ShapeElement, DiagramClientView)	Returns the control for the active in-place editor. This method may return null, in which case no in-place editor is active for this field.
GetBackgroundBrush(DiagramClientView, ShapeElement, Color)	Gets the background brush to draw with for the specified ShapeElement instance.
GetBackgroundBrushId(DiagramClientView, ShapeElement)	Gets the id of the background brush to draw with for the specified ShapeElement instance.
GetBounds(ShapeElement)	Gets the bounds of this ShapeField in world units relative to the top-left of the parent shape.
GetCursor(Cursor, DiagramClientView, PointD)	Gets the cursor that is displayed when the mouse pointer is over the ShapeField.
GetFocusable(ShapeElement)	Gets a value indicating whether the ShapeField can receive focus.
GetInPlaceEditorBounds(ShapeElement)	Returns the bounds of the in-place editor relative to its parent shape in world units.
GetMaximumInPlaceEditorSize(ShapeElement)	Returns the maximum bounds allowed for the in-place editor for the given parent shape.
GetMinimumInPlaceEditorSize(ShapeElement)	Returns the minimum bounds allowed for the in-place editor for the given parent shape.
GetMinimumSize(ShapeElement)	Gets the minimum width and height for this ShapeField in world units
GetPen(DiagramClientView, ShapeElement, Color)	Gets the pen to draw with for the specified ShapeElement instance.
GetPenId(ShapeElement)	Gets the id of the pen to draw with for the specified ShapeElement instance.
GetPotentialMouseAction(MouseButtons, PointD, DiagramHitTestInfo)	Retrieves a mouse action that should be made active on the next MouseDown event if the mouse is over the specified point. By default, this method will return the SelectAction. If the field's CanEditValue returns true and the field is already focused, then the InvokeEditorAction will be returned instead.
GetSelectable(ShapeElement)	Gets a value indicating whether the ShapeField is selectable.
GetValue(ShapeElement)	Gets the value of this ShapeField for the specified ShapeElement instance.
GetValueDomainPropertyInfo(ShapeElement)	Gets the DomainPropertyInfo for the value of this field.
GetVisible(ShapeElement)	Gets a value indicating whether the ShapeField is visible
HasFocusedAppearance(ShapeElement, DiagramClientView)	Returns a value that indicates whether this field should show the field as focused. This can be different from the Focused property when this field reflects the Focused state of its parent. (See DefaultReflectParentFocusedState property.)
HasPendingEdit(ShapeElement, DiagramClientView)	Returns a value indicating whether in-place editing is active, with a commit pending.
HasSelectedAppearance(ShapeElement, DiagramClientView)	Returns a value that indicates whether this field should show the field as selected. This can be different from the Selected property when this field reflects the Selected state of its parent. (See DefaultReflectParentSelectedState property.)
IsNavigationKey(Char)	Returns a value indicating whether the specified character corresponds to a navigational command.
IsNavigationKey(Keys)	Returns a value indicating whether the specified key data corresponds to a navigational command.
NavigateAscend(ShapeElement, SelectedShapesCollection)	Called by this ShapeField to set focus to its first focusable ancestor in the navigation sequence.
NavigateDescend(ShapeElement, SelectedShapesCollection)	Called by this ShapeField to set focus to its first focusable descendant in the navigation sequence.
NavigateToFirst(ShapeElement, SelectedShapesCollection)	Called by this ShapeField to set focus to this field's first sibling (i.e., the parent's first child) in the navigation sequence.
NavigateToLast(ShapeElement, SelectedShapesCollection)	Called by this ShapeField to set focus to this field's last sibling (i.e., the parent's last child) in the navigation sequence.
NavigateToNext(ShapeElement, SelectedShapesCollection)	Called by this ShapeField to set focus to the next object in the navigation sequence.
NavigateToPrevious(ShapeElement, SelectedShapesCollection)	Called by this ShapeField to set focus to the previous object in the navigation sequence.
OnBeginEdit(DiagramItemEventArgs)	Called when in-place editing has begun.
OnClick(DiagramPointEventArgs)	Called by the control's OnClick().
OnDoubleClick(DiagramPointEventArgs)	Called by the control's OnDoubleClick().
OnEndEdit(DiagramItemEventArgs)	Called when in-place editing has ended.
OnKeyDown(DiagramKeyEventArgs)	Called when a key is pressed. To be called, this ShapeField must be the focused ShapeField in the selection.
OnKeyPress(DiagramKeyPressEventArgs)	Called between a key down and key up. To be called, this ShapeField must be the focused ShapeField in the selection.
OnKeyUp(DiagramKeyEventArgs)	Called when a key is released. To be called, this ShapeField must be the focused ShapeField in the selection.
OnMouseDown(DiagramMouseEventArgs)	Called by the control's OnMouseDown().
OnMouseMove(DiagramMouseEventArgs)	Called by the control's OnMouseMove().
OnMouseUp(DiagramMouseEventArgs)	Called by the control's OnMouseUp().
OnMouseWheel(DiagramMouseEventArgs)	Called by the control's OnMouseWheel().
Selected(ShapeElement, DiagramClientView)	Returns a value indicating whether the field is selected.
SetSelectionRange(SelectedShapesCollection, DiagramItem, DiagramItem)	Sets the selection to a range of subfields
SetValue(ShapeElement, Object)	Sets the value of this ShapeField for the specified ShapeElement instance.
SetVisible(ShapeElement, Object)	Sets the visibility of this ShapeField for the specified ShapeElement instance.

Applies to

Partager via