TextField 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 text in a ShapeElement.
public ref class TextField : Microsoft::VisualStudio::Modeling::Diagrams::ShapeFieldpublic class TextField : Microsoft.VisualStudio.Modeling.Diagrams.ShapeFieldtype TextField = class
inherit ShapeFieldPublic Class TextField
Inherits ShapeField- Inheritance
- Derived
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
| TextField(String) |
Initializes a new instance of the TextField 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) |
| DefaultAutoSize |
If true, the text field's minimum reported size will grow to accomodate the length of the diplay text. Autosizable text fields will still respect the minimum size specified in the AnchoringBehavior. |
| DefaultBackgroundBrushId |
Gets or sets the id of the default background brush to use for this ShapeField. (Inherited from ShapeField) |
| DefaultCommitOnEscape |
Gets or sets a value indicating whether the Escape key commits the edit. If true, the Enter key will be used as a CRLF for in-place editing. |
| DefaultFocusable |
Gets or sets a value indicating whether the ShapeField can receive focus by default. (Inherited from ShapeField) |
| DefaultFontId |
Gets or sets the default font id. |
| DefaultInactiveSelectedBackgroundBrushId |
Gets or sets the id of the default background brush to use for this ShapeField. (Inherited from ShapeField) |
| DefaultInactiveSelectedTextBrushId |
Gets or sets the default brush id for the inactive selected text. |
| DefaultIsHorizontal |
Gets or sets the default horizontal state for the text. |
| DefaultMultipleLine |
Gets or sets a value indicating whether the text field is multiline. |
| 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) |
| DefaultSelectedTextBrushId |
Gets or sets the default brush id for the selected text. |
| DefaultStringFormat |
Gets or sets the default string format for text drawing. |
| DefaultText |
Gets or sets the default text to draw. |
| DefaultTextBrushId |
Gets or sets the default brush id for the text. |
| DefaultVisibility |
Gets or sets a value indicating whether the ShapeField is visible by default. (Inherited from ShapeField) |
| DisplayMember |
Gets or sets the property name that the display text is associated with. |
| DrawBorder |
(Do not use - will be changed) |
| FillBackground |
(Do not use - will be changed) |
| 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) |
By default, allow in-place editor to size automatically if the field supports auto-size. |
| 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. |
| 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. (Inherited from ShapeField) |
| DoKeyboardNavigation(Keys, DiagramClientView, DiagramItem) |
Calls the appropriate navigation method on the shape field. (Inherited from ShapeField) |
| DoPaint(DiagramPaintEventArgs, ShapeElement) |
Draws the text field. |
| EditValue(ShapeElement, DiagramClientView, PointD) |
Invokes the in-place editor, setting the caret using the specified mouse position. |
| EditValue(ShapeElement, DiagramClientView, String) |
Invokes the in-place editor, replacing the text with the specified text. |
| 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. (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 a text 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 display text as the accessible name. |
| GetAccessibleRole(ShapeElement) |
Retrieves the accessible role of this ShapeField. |
| GetAccessibleState(ShapeElement, DiagramClientView) |
Retrieves the accessible state of this TextField. By default, the TextField is invisible to accessibility clients if the field is not focusable and there is no text to display. |
| 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. |
| GetAutoSize(ShapeElement) |
If true, the text field's minimum required size will grow to accomodate the length of the diplay text. Autosizable text fields will still respect the minimum size specified in the AnchoringBehavior. |
| 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) |
| GetDisplayText(ShapeElement) |
Gets the text to be displayed by this field. |
| GetFocusable(ShapeElement) |
Gets a value indicating whether the ShapeField can receive focus. (Inherited from ShapeField) |
| GetFont(ShapeElement) |
Gets the font to draw with for the specified ShapeElement instance. |
| GetFontHeight(ShapeElement) |
Gets the line spacing of this font (i.e., the height of a line of text) in world units. Line spacing is the ascent + the descent + some recommended extra. The ascent is the height of the character above the baseline, and the descent is the height of the character below the baseline. The extra is below the descent. |
| GetFontId(ShapeElement) |
Gets the id of the font to draw with for the specified ShapeElement instance. |
| GetInPlaceEditorBounds(ShapeElement) |
Returns the bounds of the in-place editor relative to its parent shape in world units. (Inherited from ShapeField) |
| GetMaximumInPlaceEditorSize(ShapeElement) |
By default, we allow the in-place edit control to resize up to 75 characters. |
| GetMinimumInPlaceEditorSize(ShapeElement) |
Minimum in-place editor size is based on minimum width in characters and height in lines. |
| GetMinimumSize(ShapeElement) |
Gets the minimum width and heightfor this ShapeField in world units |
| GetMultipleLine(ShapeElement) |
Returns a value indicating if the text field is a multi-line text field. |
| 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) |
| GetStringFormat(ShapeElement) |
Gets the string format to draw the text with for the specified ShapeElement instance. |
| GetTextBrush(DiagramClientView, ShapeElement) |
Gets the brush to draw the text with for the specified ShapeElement instance. |
| GetTextBrushId(DiagramClientView, ShapeElement) |
Gets the id of the brush to draw the text with for the specified ShapeElement instance. |
| GetValue(ShapeElement) |
Gets the value for this TextField. |
| 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. |
| 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) |
| MeasureDisplayText(String, Font, StringFormat, SizeD) |
Helper method to measure given text. |
| 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) |
Invokes in-place editing by default. |
| 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) |
Invokes the editor if the field is editable and any alpha-numeric character is typed. |
| 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) |