ImageField Class
Definition
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.
A ShapeField which can display an image in a ShapeElement.
public ref class ImageField : Microsoft::VisualStudio::Modeling::Diagrams::ShapeFieldpublic class ImageField : Microsoft.VisualStudio.Modeling.Diagrams.ShapeFieldtype ImageField = class
inherit ShapeFieldPublic Class ImageField
Inherits ShapeField- Inheritance
Constructors
| ImageField(String, Image) |
Initializes a new instance of the ImageField class. |
| ImageField(String) |
Initializes a new instance of the ImageField class. |
Properties
| AnchoringBehavior |
Gets the AnchoringBehavior for this ShapeField. (Inherited from ShapeField) |
| DefaultAccessibleDescription |
Gets or sets the default accessible description. (Inherited from ShapeField) |
| DefaultAccessibleName |
Gets or sets the default accessible name. (Inherited from ShapeField) |
| DefaultAccessibleState |
Gets or sets the default accessible state. (Inherited from ShapeField) |
| DefaultBackgroundBrushId |
Gets or sets the id of the default background brush to use for this ShapeField. (Inherited from ShapeField) |
| DefaultFocusable |
Gets or sets a value indicating whether the ShapeField can receive focus by default. (Inherited from ShapeField) |
| DefaultImage |
Gets or sets the default image associated with this ImageField. The default image can be customized by overriding the GetDisplayImage method. |
| DefaultInactiveSelectedBackgroundBrushId |
Gets or sets the id of the default background brush to use for this ShapeField. (Inherited from ShapeField) |
| DefaultPenId |
Gets or sets the id of the default pen to use for this ShapeField. (Inherited from ShapeField) |
| DefaultReflectParentFocusedState |
Gets or sets a value indicating whether this field should show the focused state of its parent. (Inherited from ShapeField) |
| DefaultReflectParentSelectedState |
Gets or sets a value indicating whether this field should show the selected state of its parent. (Inherited from ShapeField) |
| DefaultSelectable |
Gets or sets a value indicating whether the ShapeField can be selected by default. (Inherited from ShapeField) |
| DefaultSelectedBackgroundBrushId |
Gets or sets the id of the default background brush to use for this ShapeField. (Inherited from ShapeField) |
| DefaultUnscaled |
Gets or sets whether image should be drawn unscaled with regards to the bounds of this field or image should be scaled to fit the bounds. |
| DefaultVisibility |
Gets or sets a value indicating whether the ShapeField is visible by default. (Inherited from ShapeField) |
| Name |
Gets the unique identifier for this ShapeField. (Inherited from ShapeField) |
Methods
| AccessibleDoDefaultAction(ShapeElement) |
Performs the default action associated with this accessible object. (Inherited from ShapeField) |
| AllowInPlaceEditorAutoSize(ShapeElement) |
Returns a Boolean value indicating whether in-place editor should be allowed to size automatically. Default is false. (Inherited from ShapeField) |
| 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. (Inherited from ShapeField) |
| 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. (Inherited from ShapeField) |
| 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. (Inherited from ShapeField) |
| AssociateVisibilityWith(Store, AssociatedPropertyInfo) |
Associates this shape field's visibility with a domain property on the ShapeElement. (Inherited from ShapeField) |
| 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. (Inherited from ShapeField) |
| AssociateVisibilityWith(Store, Guid) |
Associates this shape field's visibility with a domain property on the ShapeElement. (Inherited from ShapeField) |
| CanEditValue(ShapeElement, DiagramClientView) |
Returns a value indicating whether the value of this field can be edited. (Inherited from ShapeField) |
| CommitPendingEdit(ShapeElement, DiagramClientView) |
Commits the pending edit. (Inherited from ShapeField) |
| DoHitTest(PointD, ShapeElement, DiagramHitTestInfo) |
Gets a value indicating whether the specified point is within the bounds of the ShapeField. (Inherited from ShapeField) |
| DoKeyboardNavigation(Keys, DiagramClientView, DiagramItem) |
Calls the appropriate navigation method on the shape field. (Inherited from ShapeField) |
| DoPaint(DiagramPaintEventArgs, ShapeElement) |
Draws the contents of the ShapeField. |
| EditValue(ShapeElement, DiagramClientView, PointD) |
Invokes the in-place editor, setting the caret using the specified mouse position. (Inherited from ShapeField) |
| EditValue(ShapeElement, DiagramClientView) |
Invokes the in-place editor. (Inherited from ShapeField) |
| FindFirstChild(ShapeElement, Boolean) |
Called by this ShapeField to get its first child subfield in the navigation sequence. (Inherited from ShapeField) |
| FindLastChild(ShapeElement, Boolean) |
Called by this ShapeField to get its last subfield in the navigation sequence. (Inherited from ShapeField) |
| FindNextChild(DiagramItem, Boolean) |
Called by the ShapeSubField to get the next sibling item following it in the navigation sequence. (Inherited from ShapeField) |
| FindNextInChildSubFields(ShapeElement, DiagramItem, Boolean) |
Finds this ShapeField's next child subfield in the navigation sequence. (Inherited from ShapeField) |
| FindPreviousChild(DiagramItem, Boolean) |
Called by the ShapeSubField to get the next sibling item preceding it in the navigation sequence. (Inherited from ShapeField) |
| FindPreviousInChildSubFields(ShapeElement, DiagramItem, Boolean) |
Finds this ShapeField's previous child subfield in the navigation sequence. (Inherited from ShapeField) |
| Focused(ShapeElement, DiagramClientView) |
Gets a value indicating whether the ShapeField has the focus. (Inherited from ShapeField) |
| GetAccessibilityObject(ShapeElement, DiagramClientView) |
Gets the AccessibleObject assigned to the field. (Inherited from ShapeField) |
| GetAccessibleChild(ShapeElement, Int32) |
Retrieves the accessible child subfield corresponding to the specified index. (Inherited from ShapeField) |
| GetAccessibleChildCount(ShapeElement) |
Retrieves the number of accessible children belonging to this ShapeField. (Inherited from ShapeField) |
| GetAccessibleDefaultActionDescription(ShapeElement) |
Gets a string that describes the default action of the object. Not all objects have a default action. (Inherited from ShapeField) |
| GetAccessibleDescription(ShapeElement) |
Returns the default accessible description for an image field. |
| GetAccessibleHelp(ShapeElement) |
Gets a description of what the object does or how the object is used. (Inherited from ShapeField) |
| GetAccessibleHelpTopicFileName(ShapeElement) |
Gets the path to the Help file associated with this accessible object. (Inherited from ShapeField) |
| GetAccessibleHelpTopicId(ShapeElement) |
Gets an identifier for a Help topic identifier associated with this accessible object. (Inherited from ShapeField) |
| GetAccessibleName(ShapeElement) |
Returns the default accessible name for an image field. |
| GetAccessibleRole(ShapeElement) |
Retrieves the accessible role of this ShapeField. |
| GetAccessibleState(ShapeElement, DiagramClientView) |
Retrieves the accessible state of this ShapeField. (Inherited from ShapeField) |
| GetAccessibleValue(ShapeElement) |
Returns the accessible value. (Inherited from ShapeField) |
| 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. (Inherited from ShapeField) |
| GetBackgroundBrush(DiagramClientView, ShapeElement, Color) |
Gets the background brush to draw with for the specified ShapeElement instance. (Inherited from ShapeField) |
| GetBackgroundBrushId(DiagramClientView, ShapeElement) |
Gets the id of the background brush to draw with for the specified ShapeElement instance. (Inherited from ShapeField) |
| GetBounds(ShapeElement) |
Gets the bounds of this ShapeField in world units relative to the top-left of the parent shape. (Inherited from ShapeField) |
| GetCursor(Cursor, DiagramClientView, PointD) |
Gets the cursor that is displayed when the mouse pointer is over the ShapeField. (Inherited from ShapeField) |
| GetDisplayImage(ShapeElement) |
Gets the image to be displayed by this field. |
| GetFocusable(ShapeElement) |
Gets a value indicating whether the ShapeField can receive focus. (Inherited from ShapeField) |
| GetInPlaceEditorBounds(ShapeElement) |
Returns the bounds of the in-place editor relative to its parent shape in world units. (Inherited from ShapeField) |
| GetMaximumInPlaceEditorSize(ShapeElement) |
Returns the maximum bounds allowed for the in-place editor for the given parent shape. (Inherited from ShapeField) |
| GetMinimumInPlaceEditorSize(ShapeElement) |
Returns the minimum bounds allowed for the in-place editor for the given parent shape. (Inherited from ShapeField) |
| GetMinimumSize(ShapeElement) |
Returns the minimum size of the ImageField. |
| GetPen(DiagramClientView, ShapeElement, Color) |
Gets the pen to draw with for the specified ShapeElement instance. (Inherited from ShapeField) |
| GetPenId(ShapeElement) |
Gets the id of the pen to draw with for the specified ShapeElement instance. (Inherited from ShapeField) |
| 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. (Inherited from ShapeField) |
| GetSelectable(ShapeElement) |
Gets a value indicating whether the ShapeField is selectable. (Inherited from ShapeField) |
| GetUnscaled(ShapeElement) |
Gets whether the image should be drawn unscaled or not. |
| GetValue(ShapeElement) |
Gets the value of this ShapeField for the specified ShapeElement instance. (Inherited from ShapeField) |
| GetValueDomainPropertyInfo(ShapeElement) |
Gets the DomainPropertyInfo for the value of this field. (Inherited from ShapeField) |
| GetVisible(ShapeElement) |
Gets a value indicating whether the ShapeField is visible (Inherited from ShapeField) |
| 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.) (Inherited from ShapeField) |
| HasPendingEdit(ShapeElement, DiagramClientView) |
Returns a value indicating whether in-place editing is active, with a commit pending. (Inherited from ShapeField) |
| 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.) (Inherited from ShapeField) |
| IsNavigationKey(Char) |
Returns a value indicating whether the specified character corresponds to a navigational command. (Inherited from ShapeField) |
| IsNavigationKey(Keys) |
Returns a value indicating whether the specified key data corresponds to a navigational command. (Inherited from ShapeField) |
| NavigateAscend(ShapeElement, SelectedShapesCollection) |
Called by this ShapeField to set focus to its first focusable ancestor in the navigation sequence. (Inherited from ShapeField) |
| NavigateDescend(ShapeElement, SelectedShapesCollection) |
Called by this ShapeField to set focus to its first focusable descendant in the navigation sequence. (Inherited from ShapeField) |
| 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. (Inherited from ShapeField) |
| 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. (Inherited from ShapeField) |
| NavigateToNext(ShapeElement, SelectedShapesCollection) |
Called by this ShapeField to set focus to the next object in the navigation sequence. (Inherited from ShapeField) |
| NavigateToPrevious(ShapeElement, SelectedShapesCollection) |
Called by this ShapeField to set focus to the previous object in the navigation sequence. (Inherited from ShapeField) |
| OnBeginEdit(DiagramItemEventArgs) |
Called when in-place editing has begun. (Inherited from ShapeField) |
| OnClick(DiagramPointEventArgs) |
Called by the control's OnClick(). (Inherited from ShapeField) |
| OnDoubleClick(DiagramPointEventArgs) |
Called by the control's OnDoubleClick(). (Inherited from ShapeField) |
| OnEndEdit(DiagramItemEventArgs) |
Called when in-place editing has ended. (Inherited from ShapeField) |
| OnKeyDown(DiagramKeyEventArgs) |
Called when a key is pressed. To be called, this ShapeField must be the focused ShapeField in the selection. (Inherited from ShapeField) |
| OnKeyPress(DiagramKeyPressEventArgs) |
Called between a key down and key up. To be called, this ShapeField must be the focused ShapeField in the selection. (Inherited from ShapeField) |
| OnKeyUp(DiagramKeyEventArgs) |
Called when a key is released. To be called, this ShapeField must be the focused ShapeField in the selection. (Inherited from ShapeField) |
| OnMouseDown(DiagramMouseEventArgs) |
Called by the control's OnMouseDown(). (Inherited from ShapeField) |
| OnMouseMove(DiagramMouseEventArgs) |
Called by the control's OnMouseMove(). (Inherited from ShapeField) |
| OnMouseUp(DiagramMouseEventArgs) |
Called by the control's OnMouseUp(). (Inherited from ShapeField) |
| OnMouseWheel(DiagramMouseEventArgs) |
Called by the control's OnMouseWheel(). (Inherited from ShapeField) |
| Selected(ShapeElement, DiagramClientView) |
Returns a value indicating whether the field is selected. (Inherited from ShapeField) |
| SetSelectionRange(SelectedShapesCollection, DiagramItem, DiagramItem) |
Sets the selection to a range of subfields (Inherited from ShapeField) |
| SetValue(ShapeElement, Object) |
Sets the value of this ShapeField for the specified ShapeElement instance. (Inherited from ShapeField) |
| SetVisible(ShapeElement, Object) |
Sets the visibility of this ShapeField for the specified ShapeElement instance. (Inherited from ShapeField) |