Share via


LabelTextField Class

Text field displayed on a label shape.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Modeling.Diagrams.ShapeField
    Microsoft.VisualStudio.Modeling.Diagrams.TextField
      Microsoft.VisualStudio.Modeling.Diagrams.LabelTextField

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

Syntax

'Declaration
Public Class LabelTextField _
    Inherits TextField
public class LabelTextField : TextField
public ref class LabelTextField : public TextField
type LabelTextField =  
    class
        inherit TextField
    end
public class LabelTextField extends TextField

The LabelTextField type exposes the following members.

Constructors

  Name Description
Public method LabelTextField Constructs a new LabelTextField.

Top

Properties

  Name Description
Public property AnchoringBehavior Describes how the content of the field should position and size itself in relation to the parent ShapeElement. (Inherited from ShapeField.)
Public property DefaultAccessibleDescription Gets or sets the default accessible description. (Inherited from ShapeField.)
Public property DefaultAccessibleName Gets or sets the default name of the shape field for the accessible object. (Inherited from ShapeField.)
Public property DefaultAccessibleState Gets the default state of the shape field for the accessible object. (Inherited from ShapeField.)
Public property 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. (Inherited from TextField.)
Public property DefaultBackgroundBrushId Gets or sets the ID of the default brush to paint the background of the shape field. (Inherited from ShapeField.)
Public property 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. (Inherited from TextField.)
Public property 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.)
Public property DefaultFontId Gets or sets the default font id. (Inherited from TextField.)
Public property DefaultInactiveSelectedBackgroundBrushId Gets or sets the ID of the default background brush for the shape field. (Inherited from ShapeField.)
Public property DefaultInactiveSelectedTextBrushId Gets or sets the default brush id for the inactive selected text. (Inherited from TextField.)
Public property DefaultIsHorizontal Gets or sets the default horizontal state for the text. (Inherited from TextField.)
Public property DefaultMultipleLine If true, the text automatically wraps over more than one line to fit into the width available. (Inherited from TextField.)
Public property DefaultPenId Gets or sets the ID of the default pen to use for the shape field. (Inherited from ShapeField.)
Public property 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.)
Public property 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.)
Public property 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.)
Public property DefaultSelectedBackgroundBrushId Gets or sets the ID of the default background brush for the shape field. (Inherited from ShapeField.)
Public property DefaultSelectedTextBrushId Gets or sets the default brush id for the selected text. (Inherited from TextField.)
Public property DefaultStringFormat Gets or sets the default string format for text drawing. (Inherited from TextField.)
Public property DefaultText Gets or sets the default text to draw. (Inherited from TextField.)
Public property DefaultTextBrushId Gets or sets the default brush id for the text. (Inherited from TextField.)
Public property DefaultVisibility Gets the shape field and verifies whether it appears by default or sets the default visibility of the shape field. (Inherited from ShapeField.)
Public property DisplayMember Gets or sets the property name that the display text is associated with. (Inherited from TextField.)
Public property DrawBorder (Do not use - will be changed) (Inherited from TextField.)
Public property FillBackground (Do not use - will be changed) (Inherited from TextField.)
Public property Name Gets the name of the shape field. (Inherited from ShapeField.)

Top

Methods

  Name Description
Public method AccessibleDoDefaultAction Performs the default action for the accessible object. (Inherited from ShapeField.)
Public method AllowInPlaceEditorAutoSize By default, allow in-place editor to size automatically if the field supports auto-size. (Inherited from TextField.)
Public method AssociateValueWith(Store, AssociatedPropertyInfo) Associates the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
Public method AssociateValueWith(Store, Guid) Associates the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
Public method AssociateValueWith(Store, Guid, AssociatedPropertyInfo) Associates the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
Public method AssociateVisibilityWith(Store, AssociatedPropertyInfo) Associates the visibility of the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
Public method AssociateVisibilityWith(Store, Guid) Associates the visibility of the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
Public method 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.)
Public method CanEditValue Returns a value indicating whether the value of this field can be edited. (Inherited from TextField.)
Public method CommitPendingEdit Commits the pending edit. (Inherited from TextField.)
Public method 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.)
Public method DoKeyboardNavigation Navigates in the shape field by using the keyboard. (Inherited from ShapeField.)
Public method DoPaint Draws the text field. (Inherited from TextField.)
Public method EditValue(ShapeElement, DiagramClientView) Invokes the in-place editor. (Inherited from TextField.)
Public method EditValue(ShapeElement, DiagramClientView, PointD) Invokes the in-place editor, setting the caret using the specified mouse position. (Inherited from TextField.)
Public method EditValue(ShapeElement, DiagramClientView, String) Invokes the in-place editor, replacing the text with the specified text. (Inherited from TextField.)
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FindFirstChild Locates the first child shape field in the parent shape field. (Inherited from ShapeField.)
Public method FindLastChild Locates the last child shape field in the parent shape field. (Inherited from ShapeField.)
Public method FindNextChild Locates the next child shape field in the parent shape field. (Inherited from ShapeField.)
Public method FindNextInChildSubFields Locates the next child shape field in the navigation sequence. (Inherited from ShapeField.)
Public method FindPreviousChild Locates the previous child shape field in the parent shape field. (Inherited from ShapeField.)
Public method FindPreviousInChildSubFields Locates the previous child shape field in the navigation sequence. (Inherited from ShapeField.)
Public method Focused Gets the shape field and verifies whether it has focus. (Inherited from ShapeField.)
Public method GetAccessibilityObject Gets the accessibility object that is assigned to the shape field. (Inherited from ShapeField.)
Public method GetAccessibleChild Gets the Accessibility object for the child shape field. (Inherited from ShapeField.)
Public method GetAccessibleChildCount Gets the number of Accessibility objects that are assigned to the parent shape field and its child shape fields. (Inherited from ShapeField.)
Public method GetAccessibleDefaultActionDescription Gets the default purpose of the shape field for the accessible object. (Inherited from ShapeField.)
Public method GetAccessibleDescription Returns the default accessible description for a text field. (Inherited from TextField.)
Public method GetAccessibleHelp Gets the shape field Help for the accessible object. (Inherited from ShapeField.)
Public method GetAccessibleHelpTopicFileName Gets a topic in the Help for the accessible object. (Inherited from ShapeField.)
Public method GetAccessibleHelpTopicId Gets the ID that is assigned to the Help topic for the accessible object. (Inherited from ShapeField.)
Public method GetAccessibleName Returns the display text as the accessible name. (Inherited from TextField.)
Public method GetAccessibleRole Retrieves the accessible role of this ShapeField. (Inherited from TextField.)
Public method GetAccessibleState 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. (Inherited from TextField.)
Public method GetAccessibleValue Returns the accessible value. (Inherited from TextField.)
Public method GetActiveInPlaceEditor 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 TextField.)
Public method GetAutoSize 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. (Inherited from TextField.)
Public method GetBackgroundBrush Gets the brush that draws the background for the shape element to which this shape field is assigned. (Inherited from ShapeField.)
Public method 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.)
Public method GetBounds Gets the bounds for the shape field. (Inherited from ShapeField.)
Public method GetCursor Gets the pointer that appears when the mouse is pointing to the shape field. (Inherited from ShapeField.)
Public method GetDisplayText Gets the text to be displayed by this field. (Inherited from TextField.)
Public method GetFocusable Gets the shape field and verifies whether it can receive focus. (Inherited from ShapeField.)
Public method GetFont Gets the font to draw with for the specified ShapeElement instance. (Inherited from TextField.)
Public method GetFontHeight 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. (Inherited from TextField.)
Public method GetFontId Gets the id of the font to draw with for the specified ShapeElement instance. (Inherited from TextField.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetInPlaceEditorBounds Gets the bounds for the in-place editor. (Inherited from ShapeField.)
Public method GetMaximumInPlaceEditorSize By default, we allow the in-place edit control to resize up to 75 characters. (Inherited from TextField.)
Public method GetMinimumInPlaceEditorSize Minimum in-place editor size is based on minimum width in characters and height in lines. (Inherited from TextField.)
Public method GetMinimumSize Gets the minimum width and heightfor this ShapeField in world units (Inherited from TextField.)
Public method GetMultipleLine If true, the text can wrap onto more than one line to fit the width available. (Inherited from TextField.)
Public method GetPen Gets the pen that draws the shape element to which the shape field is assigned. (Inherited from ShapeField.)
Public method GetPenId Gets the ID of the pen that draws the shape element to which the shape field is assigned. (Inherited from ShapeField.)
Public method GetPotentialMouseAction Gets the mouse action to activate when the user next clicks a specific point on the diagram. (Inherited from ShapeField.)
Public method GetSelectable Gets the shape field and verifies whether it can be selected. (Inherited from ShapeField.)
Public method GetStringFormat Gets the string format to draw the text with for the specified ShapeElement instance. (Inherited from TextField.)
Public method GetTextBrush Gets the brush to draw the text with for the specified ShapeElement instance. (Inherited from TextField.)
Public method GetTextBrushId Gets the id of the brush to draw the text with for the specified ShapeElement instance. (Inherited from TextField.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValue Gets the value for this TextField. (Inherited from TextField.)
Public method GetValueDomainPropertyInfo Gets the domain property that is assigned to the value in the shape field. (Inherited from ShapeField.)
Public method GetVisible Gets the shape field and verifies whether it appears. (Inherited from ShapeField.)
Public method HasFocusedAppearance Gets the shape field and verifies whether it should appear to have the focus. (Inherited from ShapeField.)
Public method HasPendingEdit Returns a value indicating whether in-place editing is active, with a commit pending. (Inherited from TextField.)
Public method HasSelectedAppearance Gets the shape field and verifies whether it appears to be selected. (Inherited from ShapeField.)
Public method IsNavigationKey(Char) Gets the key that the user pressed and verifies whether it can be used to navigate between shape fields. (Inherited from ShapeField.)
Public method IsNavigationKey(Keys) Gets the keys that the user pressed and verifies whether they can be used to navigate between shape fields. (Inherited from ShapeField.)
Protected method MeasureDisplayText Helper method to measure given text. (Inherited from TextField.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method NavigateAscend Moves the focus to the previous shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
Public method NavigateDescend Moves the focus to the next shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
Public method NavigateToFirst Moves the focus to the first shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
Public method NavigateToLast Moves the focus to the last shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
Public method NavigateToNext Moves the focus to the next shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
Public method NavigateToPrevious Moves the focus to the previous shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
Protected method OnBeginEdit Alerts listeners when in-place editing has begun. (Inherited from ShapeField.)
Public method OnClick Alerts listeners when the user has clicked a shape field. (Inherited from ShapeField.)
Public method OnDoubleClick Invokes in-place editing by default. (Inherited from TextField.)
Protected method OnEndEdit Alerts listeners when in-place editing has completed. (Inherited from ShapeField.)
Public method OnKeyDown keys directed to the text field so that we can nudge, resize, scroll, etc. when the text field has the focus. (Overrides ShapeField.OnKeyDown(DiagramKeyEventArgs).)
Public method OnKeyPress Invokes the editor if the field is editable and any alpha-numeric character is typed. (Inherited from TextField.)
Public method OnKeyUp Alerts listeners when the user has released a key when pointing to a shape field. (Inherited from ShapeField.)
Public method OnMouseDown Alerts listeners when the user is holding down the mouse over a shape field. (Inherited from ShapeField.)
Public method OnMouseMove Alerts listeners when the mouse has been moved over a shape field. (Inherited from ShapeField.)
Public method OnMouseUp Alerts listeners when the user has released the mouse button over a shape field. (Inherited from ShapeField.)
Public method OnMouseWheel Alerts listeners when the mouse has been rotated over a shape field. (Inherited from ShapeField.)
Public method Selected Gets the shape field and verifies whether it is selected. (Inherited from ShapeField.)
Public method SetSelectionRange Sets the selection to a range of child shape fields. (Inherited from ShapeField.)
Public method SetValue Assigns the specified value to a shape field. (Inherited from ShapeField.)
Public method SetVisible Sets the visibility of the shape field. (Inherited from ShapeField.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

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