GraphObject Class

Article
2011-05-22

This class makes an object extensible by adding a strongly typed property bag of name/value pairs.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.GraphModel.GraphObject
    Microsoft.VisualStudio.GraphModel.Graph
    Microsoft.VisualStudio.GraphModel.GraphLink
    Microsoft.VisualStudio.GraphModel.GraphMetadata
    Microsoft.VisualStudio.GraphModel.GraphNode
    Microsoft.VisualStudio.GraphModel.Styles.GraphCondition
    Microsoft.VisualStudio.GraphModel.Styles.GraphConditionalStyle
    Microsoft.VisualStudio.GraphModel.Styles.GraphSetter

Namespace: Microsoft.VisualStudio.GraphModel
Assembly: Microsoft.VisualStudio.GraphModel (in Microsoft.VisualStudio.GraphModel.dll)

Syntax

'Declaration
Public MustInherit Class GraphObject

public abstract class GraphObject

public ref class GraphObject abstract

[<AbstractClass>]
type GraphObject =  class end

public abstract class GraphObject

The GraphObject type exposes the following members.

Constructors

	Name	Description
	GraphObject()	Protected constructor for Annotatable
	GraphObject(Graph)	Protected constructor for Annotatable

Top

Properties

	Name	Description
	Categories	Return all categories. Never returns null.
	CategoryCount	Return number of categories in the object.
	DescriptiveCategoryCaption
	IsCollapsed	Get whether this node is collapsed.
	IsExpanded	Get whether this node is expanded.
	IsGroup	Get whether this object is IsGroup. It looks for the GraphProperties.StyleForGroup
	IsPseudo	Get whether this object is Pseudo. It looks for the GraphProperties.IsPseudo
	Item	Property that gets or sets a property value.
	Owner	Get the Graph object that this object belongs to.
	Properties	Property that returns an enumeration of all annotations. The order of the enumeration is random.
	PropertyCount	Property that returns an number of of all annotations.
	PropertyKeys	Property that returns an enumeration of all annotation keys. The order of the enumeration is random.
	PropertyValues	Property that returns an enumeration of all annotation values. The order of the enumeration is random.
	Visibility	Helper property to get/set visibility property of a GraphObject

Top

Methods

	Name	Description
	AddCategory	Add a category to the object
	ClearCategories	Remove all categories from this object.
	ClearValue(GraphProperty)	Removes the value of the specified property
	ClearValue<T>(GraphProperty)	Clear the value of the specified property.
	CopyCategories	Copy any new categories from the given object, keeping existing categories.
	CopyProperties	Copy any new properties from the given object, keeping existing property values unchanged.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue(GraphProperty)	Gets the value of the specified annotation.
	GetValue<T>(GraphProperty)	Gets the value of the specified property.
	GetValue<T>(GraphProperty, Graph)	Gets the value of the specified property.
	GetValue<T>(GraphProperty, T)	Gets the value of the specified annotation. if property is not set we reutnr the default value that the caller pass to this method
	GetValue<T>(GraphProperty, Graph, GraphCategory%)	Gets the value of the specified property, and also return the category that this property value was inherited from if any.
	GetValueAsString	Returns the given property as a string using the given culture.
	HasCategory(String)	Return true if the object has the given category.
	HasCategory(GraphCategory)	Return true if the object has the given category.
	HasCategory(IEnumerable<GraphCategory>)	Return true if the object has any of the given categories.
	HasCategoryInSet	Determines if the given set of categories applies to this object.
	HasValue	Return true if the specified annotation exists.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RemoveCategory	Remove the category of this object
	SetValue<T>	Sets the value of the given property. If the proeprty already exists, its value is overwritten unless the annotation flags prevent otherwise.
	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.

Share via