ShapeElement 类
表示关系图或形状或连接到关系图。ShapeElements 封装模型元素的可视形式。
继承层次结构
System.Object
Microsoft.VisualStudio.Modeling.ModelElement
Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement
Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement
Microsoft.VisualStudio.Modeling.Diagrams.LinkShape
Microsoft.VisualStudio.Modeling.Diagrams.NodeShape
命名空间: Microsoft.VisualStudio.Modeling.Diagrams
程序集: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0(在 Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0.dll 中)
语法
声明
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement.DisplayName", _
GetType(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")> _
<DomainObjectIdAttribute("ffb3d9f5-7a47-4e12-8501-0055bd018825")> _
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement.Description", _
GetType(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")> _
<DomainModelOwnerAttribute(GetType(CoreDesignSurfaceDomainModel))> _
<CLSCompliantAttribute(True)> _
Public MustInherit Class ShapeElement _
Inherits PresentationElement _
Implements IGeometryHost
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement.DisplayName",
typeof(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[DomainObjectIdAttribute("ffb3d9f5-7a47-4e12-8501-0055bd018825")]
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement.Description",
typeof(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(CoreDesignSurfaceDomainModel))]
[CLSCompliantAttribute(true)]
public abstract class ShapeElement : PresentationElement,
IGeometryHost
ShapeElement 类型公开以下成员。
构造函数
名称 | 说明 | |
---|---|---|
ShapeElement | 初始化 ShapeElement 类的新实例。 |
页首
属性
名称 | 说明 | |
---|---|---|
AbsoluteBoundingBox | 边框,测量相对关系图。 | |
AbsoluteBoundingBoxToEnsureVisible | 获取 DiagramClientView.EnsureVisible的绝对边框。 | |
AbsoluteCenter | 在图形中心获取点。 | |
AccessibilityObject | 获取形状的可访问性对象。 | |
AccessibleDefaultActionDescription | 获取形状的默认事件声明。 | |
AccessibleDescription | 获取形状的说明。 | |
AccessibleHelp | 获取形状的帮助。 | |
AccessibleHelpTopicFileName | 获取形状的帮助主题。 | |
AccessibleHelpTopicId | 获取帮助主题的 ID 形状的。 | |
AccessibleName | 获取形状的名称。 | |
AccessibleRole | 获取形状的角色。 | |
AccessibleState | 获取形状的状态。 | |
AccessibleValue | 获取形状的值。 | |
AllowsChildrenInSelection | 如果 true,形状的子级可以在当前选定组中。 | |
AllowsChildrenToResizeParent | true ,如果形状的大小进行调整,当更改子形状的大小或位置。 | |
AllowsChildrenToShrinkParent | 如果为 true,则此形状的大小将减小到适应在其子周围,当调整大小或移动。 | |
BackgroundBrushId | 获取用于绘制形状的背景的画笔的 ID。 | |
BoundingBox | 边框,测量相对 ParentShape。 | |
CanFocus | 获取形状并验证它是否可以接收焦点。 | |
CanMove | 获取形状并验证用户是否可以移动它。 | |
CanSelect | 获取形状并验证用户是否可以选择它。 | |
Center | 在图形中心获取点。 | |
ClassStyleSet | 获取该样式设置为形状。 | |
ClipWhenDrawingFields | 获取子形状并验证是否应将其剪辑区域到父形状的边界框,在绘制时子形状。 | |
Decorators | 获取修饰器的集合形状的。 | |
DefaultShapeField | 获取默认值形状,是第一个形状都可以接收焦点。 | |
DefaultSize | 获取形状的默认大小。 | |
Diagram | 获取形状属于的关系图。 | |
EnsureVisiblePreference | EnsureVisible 方法的喜好形状的。默认值为返回承载形状的关系图的 VisiblePreference。 | |
Events | 获取事件处理程序的列表形状的。 | |
GeometryBackgroundBrushId | 获取用于绘制几何形状的背景画笔的 ID。 | |
GeometryBoundingBox | 获取形状的边界框。 | |
GeometryHasFilledBackground | 获取形状并验证其背景是否绘制。 | |
GeometryHasOutline | 获取形状并验证它是否具有轮廓。 | |
GeometryHasShadow | true ,则形状具有隐藏;否则, false。 | |
GeometryOutlinePenId | 获取绘制形状的轮廓钢笔的 ID。 | |
GeometryStyleSet | 获取该样式设置为形状。 | |
GridSize | 如果非零,则形状及其子控件将在此范围网格。为 ParentShape.GridSize 的默认值。 | |
HasChildren | true ,则形状具有子形状。 | |
HasCustomToolTip | 获取形状并验证它是否具有自定义工具提示。 | |
HasDragOverToolTip | 获取形状并验证它是否具有工具提示。 | |
HasFilledBackground | 获取形状并验证它是否具有背景。 | |
HasHighlighting | 获取形状并验证它是否显示。 | |
HasOutline | 获取形状并验证它是否具有轮廓。 | |
HasShadow | 获取形状并验证它是否有阴影效果。 | |
HasToolTip | 获取形状并验证它是否具有工具提示。 | |
Id | 获取元素的 ID。 (继承自 ModelElement。) | |
IsActive | 获取 IsActive 标志并验证来确定该元素是否处于活动状态。 (继承自 ModelElement。) | |
IsDeleted | 获取 IsDeleted 标志并检查来确定该元素是否从模型中删除。 (继承自 ModelElement。) | |
IsDeleting | 获取 IsDeleting 标志并验证元素是否从模型当前被删除。 (继承自 ModelElement。) | |
IsNestedChild | true ,则此形状元素在其 ParentShapeNestedChildShapes 。 | |
IsRelativeChild | true ,则此形状元素在其 ParentShapeRelativeChildShapes 。 | |
IsVisible | 如果 true,形状显示在关系图上;如果 false,它不会和布局和路由算法忽略它。请参见 Hide() 和 Show()。 | |
LineAdjustAwayDefault | 获取形状并验证子链接形状是否应尝试对齐,这会连接到同一形状时或设置此值。 | |
LineAffinityDefault | 获取或设置指向形状应尝试定位形状的目标位置。 | |
LineToLineClearance | 获取或设置子链接形状之间的距离形状的。 | |
LineToNodeClearance | 获取或设置子链接形状和子节点形状之间的距离。 | |
MaximumShadowOffset | 获取形状阴影的最大偏移量。 | |
MaximumSize | 获取形状的最大大小。 | |
MinimumSize | 获取形状的最小尺寸。 | |
ModelElement | 获取或设置与表示元素的模型元素。 (继承自 PresentationElement。) | |
NestedChildShapes | 是形状的一部分形状的列表,和约束此形状或关系图中区域中。 | |
NestedShapesMargin | 获取边距在形状的边界框及其嵌套节点形状之间。 | |
NodeToNodeClearance | 获取或设置在子节点形状之间的边距。 | |
OutlinePenId | 获取用于绘制形状的轮廓钢笔的 ID。 | |
OutlinePenWidth | 获取边框的宽度形状的。 | |
PaintMoveableDecoratorSelectionLines | ||
ParentLink | 从形状具有关系实例父形状。 | |
ParentShape | 获取父形状元素。若要显示在关系图上,形状或连接必须具有父级。 | |
Partition | 获取或设置一个元素的 Partition 。 (继承自 ModelElement。) | |
Perimeter | 在形状周围获取周长 (path)。 | |
RelatedShapeToEmphasize | ,当形状时,获取相关形状以可视方式基础给用户。 | |
RelativeChildShapes | 是形状的一部分形状的列表,但是,可以在该形状的边界显示。 | |
ShapeFields | 形状的部分例如文本行和修饰器。 | |
ShapeGeometry | 获取形状的几何图形,如矩形、 RoundedRectangle 或椭圆,定义操作与形状的轮廓。 | |
ShouldTryParentShapeForMergeOnToolboxDoubleClick | 如果为 true,则,当用户双击与选定的形状的一个 " 工具箱 " 项,因此,如果工具不能与形状合并,然后与父形状的组合将尝试。true 的默认值。 | |
Store | 获取包含元素的 Store 。 (继承自 ModelElement。) | |
StyleSet | 获取的形状设置样式的实例。 | |
Subject | 获取或设置表示元素的主题。对对象的默认和 ModelElement相同。 (继承自 PresentationElement。) | |
TargetToolboxItemFilterAttributes | 获取用于确定属性的集合项在工具箱中启用还是禁用。 | |
ZOrder | 确定此形状将显示相对于关系图的其他形状的顺序。通常设置从子级命令模型。 |
页首
方法
页首
事件
名称 | 说明 | |
---|---|---|
Click | ,当用户单击该形状,将鼠标发生。 | |
DoubleClick | ,当用户双击鼠标,发生。 | |
KeyDown | ,当用户按键,发生。 | |
KeyPress | 发生,当用户按和版本键。 | |
KeyUp | ,当用户松开键,发生。 | |
MouseDown | ,当用户按下鼠标按钮,发生。 | |
MouseMove | ,当用户移动鼠标,发生。 | |
MouseUp | ,当用户松开鼠标按钮,发生。 | |
MouseWheel | ,当用户滚动鼠标轮,发生。 |
页首
扩展方法
名称 | 说明 | |
---|---|---|
AddExtension(Guid) | 已重载。 扩展由标识的字段类型的最新实例化的扩展的此 ModelElement。,如果元素已有该类型,扩展 InvalidOperationException 将引发异常。 (由 ModelElementExtensionMethods 定义。) | |
AddExtension(Type) | 已重载。 扩展具有指定类型的一个新实例化的扩展的此 ModelElement。,如果元素已有该类型,扩展 InvalidOperationException 将引发异常。 (由 ModelElementExtensionMethods 定义。) | |
AddExtension(DomainClassInfo) | 已重载。 扩展指定的字段类型的一个新实例化的扩展的此 ModelElement。,如果元素已有该类型,扩展 InvalidOperationException 将引发异常。 (由 ModelElementExtensionMethods 定义。) | |
AddExtension(ExtensionElement) | 已重载。 扩展特定扩展的此 ModelElement。,如果元素已具有相同类型的扩展, InvalidOperationException 将引发异常。 (由 ModelElementExtensionMethods 定义。) | |
AddExtension<T>() | 已重载。 扩展特定类型的一个新实例化的扩展的此 ModelElement。,如果元素已具有相同类型的扩展, InvalidOperationException 将引发异常。 (由 ModelElementExtensionMethods 定义。) | |
CanDelete | 从模型中删除元素。 (由 ImmutabilityExtensionMethods 定义。) | |
GetAllExtensions | 返回对扩展组件之间树的范围第一个遍历本 ModelElement 嵌入的可枚举的。 (由 ModelElementExtensionMethods 定义。) | |
GetBaseElement | 返回指定的 ModelElement 参与虚拟麦的根。 (由 ModelElementExtensionMethods 定义。) | |
GetDslDefinitionModelElement | 此方法保证返回与 PresentationElement 对应的真实模型元素。 对于 DslDesigner PELs , 对应的主题实际上可以为内在的 TreeNode 类,而不是实际的 MEL。 此方法恰当地处理这些用例,以便返回实际的 MEL。 (由 PresentationElementHelper 定义。) | |
GetExtension(Guid) | 已重载。 (由 ModelElementExtensionMethods 定义。) | |
GetExtension(Type) | 已重载。 获取指定类型的 ExtensionElement 从此 ModelElement 可扩展的。如果元素没有此类扩展因此 InvalidOperationException 将引发。 (由 ModelElementExtensionMethods 定义。) | |
GetExtension(DomainClassInfo) | 已重载。 (由 ModelElementExtensionMethods 定义。) | |
GetExtension<T>() | 已重载。 获取指定类型的 ExtensionElement 从此 ModelElement 可扩展的。如果元素没有此类扩展因此 InvalidOperationException 将引发。 (由 ModelElementExtensionMethods 定义。) | |
GetLocks | 获取此元素的锁标志。这将包括分区中启用的任何锁包含元素。 (由 ImmutabilityExtensionMethods 定义。) | |
IsExtendedBy(Guid) | 已重载。 查询此 ModelElement 是否由特定类型的 ExtensionElement 当前扩展。 (由 ModelElementExtensionMethods 定义。) | |
IsExtendedBy(Type) | 已重载。 查询此 ModelElement 是否由特定类型的 ExtensionElement 当前扩展。 (由 ModelElementExtensionMethods 定义。) | |
IsExtendedBy(DomainClassInfo) | 已重载。 查询此 ModelElement 是否由特定类型的 ExtensionElement 当前扩展。 (由 ModelElementExtensionMethods 定义。) | |
IsLocked | 测试存在任何指定的此元素是否设置锁定 (由 ImmutabilityExtensionMethods 定义。) | |
RemoveExtension(Type) | 已重载。 移除是一种特殊类型的此 ModelElement 的所有扩展。 (由 ModelElementExtensionMethods 定义。) | |
RemoveExtension(Guid) | 已重载。 移除是一种特殊类型指定的 ModelElement 的所有扩展。 (由 ModelElementExtensionMethods 定义。) | |
RemoveExtension(DomainClassInfo) | 已重载。 移除是一种特殊类型指定的 ModelElement 的所有扩展。 (由 ModelElementExtensionMethods 定义。) | |
RemoveExtension(ExtensionElement) | 已重载。 从此 ModelElement 扩展移除指定的 ExtensionElement。 (由 ModelElementExtensionMethods 定义。) | |
SetLocks | 将此元素锁定标志 (由 ImmutabilityExtensionMethods 定义。) | |
TryGetExtension(Guid) | 已重载。 (由 ModelElementExtensionMethods 定义。) | |
TryGetExtension(Type) | 已重载。 (由 ModelElementExtensionMethods 定义。) | |
TryGetExtension(DomainClassInfo) | 已重载。 (由 ModelElementExtensionMethods 定义。) | |
TryGetExtension<T>() | 已重载。 获取指定类型的 ExtensionElement 从此 ModelElement 可扩展的。如果此元素没有此类扩展则结果将为空。 (由 ModelElementExtensionMethods 定义。) |
页首
字段
名称 | 说明 | |
---|---|---|
DomainClassId | 表示分配给形状的 ID。 |
页首
显式接口实现
名称 | 说明 | |
---|---|---|
IMergeElements.CanMerge | ,如果此元素可与原型的内容,将返回 true。 (继承自 ModelElement。) | |
IMergeElements.ChooseMergeTarget(ElementGroup) | (继承自 ModelElement。) | |
IMergeElements.ChooseMergeTarget(ElementGroupPrototype) | (继承自 ModelElement。) | |
IMergeElements.MergeConfigure | (继承自 ModelElement。) | |
IMergeElements.MergeDisconnect | (继承自 ModelElement。) | |
IMergeElements.MergeRelate | (继承自 ModelElement。) |
页首
备注
若要定位到形状表示的模型元素或关系,请使用 ModelElement。
重要子类型包括:
Diagram –表示形状和连接线的集合。关系图的内容。 .diagram 文件仍然存在。如果在 DSL 定义指定关系图类,它从该类派生。
NodeShape –表示具有非零区域的形状,不是连接。如果在 DSL 定义指定形状类,它们从 NodeShape 派生。
BinaryLinkShape –表示两 NodeShapes 之间的一行。如果在 DSL 定义指定 connect 类,它们在此 BinaryLinkShape 派生。
有关更多信息,请参见 [重定向] 如何:导航和更新图表。
线程安全
此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。但不保证所有实例成员都是线程安全的。
请参见
参考
Microsoft.VisualStudio.Modeling.Diagrams 命名空间