ShapeField 类

委托形状的部分可以显示项 (如背景图像、文本修饰人员和与修饰人员的轻型对象。

继承层次结构

System.Object
  Microsoft.VisualStudio.Modeling.Diagrams.ShapeField
    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
    Microsoft.VisualStudio.Modeling.Diagrams.ToggleButtonField

命名空间:  Microsoft.VisualStudio.Modeling.Diagrams
程序集:  Microsoft.VisualStudio.Modeling.Sdk.Diagrams.12.0(在 Microsoft.VisualStudio.Modeling.Sdk.Diagrams.12.0.dll 中)

语法

声明
Public MustInherit Class ShapeField
public abstract class ShapeField

ShapeField 类型公开以下成员。

构造函数

  名称 说明
受保护的方法 ShapeField 初始化 ShapeField 类的新实例。

页首

属性

  名称 说明
公共属性 AnchoringBehavior 描述该字段的内容应该如何放置和调整有关父 ShapeElement 大小。
公共属性 DefaultAccessibleDescription 获取或设置默认可访问说明。
公共属性 DefaultAccessibleName 获取或设置可访问对象的形状字段的默认名称。
公共属性 DefaultAccessibleState 为可访问对象获取形状字段的默认状态。
公共属性 DefaultBackgroundBrushId 获取或设置用于绘制形状字段的背景的默认画笔的 ID。
公共属性 DefaultFocusable 获取形状字段并验证它是否可以接收焦点,或者对形状字段提供接收焦点的功能。
公共属性 DefaultInactiveSelectedBackgroundBrushId 获取或设置形状字段的默认背景画笔的 ID。
公共属性 DefaultPenId 获取或设置用于形状字段的默认钢笔的 ID。
公共属性 DefaultReflectParentFocusedState 获取子形状字段,并确认在其父形状接收焦点或将功能设置为反射其父形状的焦点状态时,它是否应接收焦点。
公共属性 DefaultReflectParentSelectedState 获取子形状字段,并确认在选中其父形状或将功能设置为反射其父形状的选中状态时,是否应选中它。
公共属性 DefaultSelectable 获取形状字段并验证是否选择默认情况下或设置形状字段的默认选择状态。
公共属性 DefaultSelectedBackgroundBrushId 获取或设置形状字段的默认背景画笔的 ID。
公共属性 DefaultVisibility 获取形状字段并验证是否默认情况下显示或设置形状字段的默认可见性。
公共属性 Name 获取形状字段的名称。

页首

方法

  名称 说明
公共方法 AccessibleDoDefaultAction 执行该辅助性对象的默认操作。
公共方法 AllowInPlaceEditorAutoSize 使在位编辑器自动调整到形状字段的大小。
公共方法 AssociateValueWith(Store, AssociatedPropertyInfo) 将形状字段与分配到形状元素的域属性关联。
公共方法 AssociateValueWith(Store, Guid) 将形状字段与分配到形状元素的域属性关联。
公共方法 AssociateValueWith(Store, Guid, AssociatedPropertyInfo) 将形状字段与分配到形状元素的域属性关联。
公共方法 AssociateVisibilityWith(Store, AssociatedPropertyInfo) 将形状字段的可见性与分配到形状元素的域属性关联。
公共方法 AssociateVisibilityWith(Store, Guid) 将形状字段的可见性与分配到形状元素的域属性关联。
公共方法 AssociateVisibilityWith(Store, Guid, AssociatedPropertyInfo) 将形状字段的可见性与分配到形状元素的域属性关联。
公共方法 CanEditValue 获取形状字段并验证它是否可以编辑。
公共方法 CommitPendingEdit 提交挂起的编辑。
公共方法 DoHitTest 在关系图上指定的点执行命中测试以确定点是否位于形状字段的边界。
公共方法 DoKeyboardNavigation 在形状段用此键盘导航。
公共方法 DoPaint 绘制形状字段。
公共方法 EditValue(ShapeElement, DiagramClientView) 打开形状字段的内置编辑器。
公共方法 EditValue(ShapeElement, DiagramClientView, PointD) 打开形状字段的内置编辑器。
公共方法 Equals 确定指定的对象是否等于当前对象。 (继承自 Object。)
受保护的方法 Finalize 允许对象在“垃圾回收”回收之前尝试释放资源并执行其他清理操作。 (继承自 Object。)
公共方法 FindFirstChild 找到在父形状字段中的第一个子形状字段。
公共方法 FindLastChild 找到在父形状字段中的最后一个子形状字段。
公共方法 FindNextChild 找到在父形状字段中的下一个子形状字段。
公共方法 FindNextInChildSubFields 找到在导航序列中的下一个子形状字段。
公共方法 FindPreviousChild 找到在父形状字段中的上一个子形状字段。
公共方法 FindPreviousInChildSubFields 找到在导航序列中的上一个子形状字段。
公共方法 Focused 获取形状字段并验证是否具有焦点。
公共方法 GetAccessibilityObject 获取分配给形状字段的 accessibility 对象。
公共方法 GetAccessibleChild 获取子形状字段的 Accessibility 对象。
公共方法 GetAccessibleChildCount 获取分配给父级形状字段和子形状字段的辅助功能对象的数目。
公共方法 GetAccessibleDefaultActionDescription 为可访问对象获取形状字段的默认用途。
公共方法 GetAccessibleDescription 为可访问对象获取形状字段的默认状态。
公共方法 GetAccessibleHelp 获取辅助性对象的形状字段 Help。
公共方法 GetAccessibleHelpTopicFileName 为可访问的对象在“帮助”中获取主题。
公共方法 GetAccessibleHelpTopicId 获取可访问对象的帮助主题 ID。
公共方法 GetAccessibleName 获取访问对象的形状字段的名称。
公共方法 GetAccessibleRole 获取访问对象的形状字段的角色。
公共方法 GetAccessibleState 获取用于可访问对象的形状字段的状态。
公共方法 GetAccessibleValue 获取可访问对象的形状字段中的值。
公共方法 GetActiveInPlaceEditor 获取活动的就地编辑。
公共方法 GetBackgroundBrush 获取将绘制此形状字段将分配到的形状元素的背景的画笔。
公共方法 GetBackgroundBrushId 获取一个画笔 ID,该画笔被用来绘制当前形状被分配到的形状的背景。
公共方法 GetBounds 获取形状字段的边界。
公共方法 GetCursor 获取当鼠标指向形状字段时显示的指针。
公共方法 GetFocusable 获取形状字段并验证它是否可以接收该焦点。
公共方法 GetHashCode 作为默认哈希函数。 (继承自 Object。)
公共方法 GetInPlaceEditorBounds 获取就绪编辑器的边界。
公共方法 GetMaximumInPlaceEditorSize 获取就地编辑的最大边界。
公共方法 GetMinimumInPlaceEditorSize 获取就地编辑的最大边界。
公共方法 GetMinimumSize 获取用于形状字段的最小宽度和高度。
公共方法 GetPen 获取用于绘制形状字段被分配到的形状元素的钢笔。
公共方法 GetPenId 获取形状字段被指定到的形状要素的笔 ID 。
公共方法 GetPotentialMouseAction 在用户接下来单击关系图上特定点时,获取引起该事件的鼠标操作并将其激活。
公共方法 GetSelectable 获取形状字段并验证它是否可以选择。
公共方法 GetType 获取当前实例的 Type。 (继承自 Object。)
公共方法 GetValue 获取形状字段中的值。
公共方法 GetValueDomainPropertyInfo 获取向形状字段中的值赋予的域属性。
公共方法 GetVisible 获取形状字段并验证是否显示。
公共方法 HasFocusedAppearance 获取形状字段并验证它是否应显示一个具有焦点。
公共方法 HasPendingEdit 获取形状字段并验证就地编辑是否处于活动状态并更改挂起。
公共方法 HasSelectedAppearance 获取形状字段并验证是否显示选中。
公共方法 IsNavigationKey(Char) 获取用户按下的键并验证它是否可用于形状之间字段的导航。
公共方法 IsNavigationKey(Keys) 获取用户按下的按键组合并验证它们是否可用于形状之间字段的导航。
受保护的方法 MemberwiseClone 创建当前 Object 的浅表副本。 (继承自 Object。)
公共方法 NavigateAscend 移动焦点至用于选定形状的导航序列的上一个形状字段。
公共方法 NavigateDescend 移动焦点至用于选定形状的导航序列的下一个形状字段。
公共方法 NavigateToFirst 移动焦点至用于选定形状的导航序列的第一个形状字段。
公共方法 NavigateToLast 移动 焦点至用于选定形状的导航序列的最后的形状字段。
公共方法 NavigateToNext 移动焦点至用于选定形状的导航序列的下一个形状字段。
公共方法 NavigateToPrevious 移动焦点至用于选定形状的导航序列的上一个形状字段。
受保护的方法 OnBeginEdit 当就地编辑启动时,警报侦听器。
公共方法 OnClick 当用户单击形状字段时,警报侦听器。
公共方法 OnDoubleClick 当用户双击形状字段时,警报侦听器。
受保护的方法 OnEndEdit 当就地编辑完成时,警报侦听器。
公共方法 OnKeyDown 当指向形状字段,用户按住了密钥时,警报侦听器。
公共方法 OnKeyPress 当指向形状字段,用户按住密钥时,警报侦听器。
公共方法 OnKeyUp 当指向形状字段,用户释放了密钥时,警报侦听器。
公共方法 OnMouseDown 用户按住鼠标按钮到形状字段上时,警报侦听器。
公共方法 OnMouseMove 鼠标移动到形状字段上时,警报侦听器。
公共方法 OnMouseUp 用户释放鼠标按钮到形状字段上时,警报侦听器。
公共方法 OnMouseWheel 鼠标旋转到形状字段上时,警报侦听器。
公共方法 Selected 获取形状字段并验证它是否已选中。
公共方法 SetSelectionRange 设置该选择到子形状字段的范围。
公共方法 SetValue 将指定的参数赋予形状字段。
公共方法 SetVisible 设置形状字段的可见性。
公共方法 ToString 返回表示当前对象的字符串。 (继承自 Object。)

页首

备注

当定义形状的时,它将 ShapeField 表示一个修饰器。 ShapeFields 也用于表示在更复杂的形状内的区域 (如 CompartmentShapes。

形状字段是管理在一个形状内的区域,如图像或标签空间分配给的对象。 一 ShapeField 实例之间共享同一类的多个形状之间。 形状实例字段包含不显示的元素。

常用的派生类为 TextFieldImageField

形状字段可以具有子体,由 ShapeSubField表示。

有关 ShapeFields 的初始化的示例,请在 Dsl\GeneratedCode\Shapes.cs in your DSL 解决方案中的 InitializeShapeFields()。 此方法为每个调用一次类形状。 您可以通过重写 InitializeShapeFields()类的自定义形状形状字段。

示例

有关示例,请参见TextFieldImageField

线程安全

此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。但不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.VisualStudio.Modeling.Diagrams 命名空间