GraphMetadata Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

This class is used to provide more information about a GraphProperty, including localized strings and flags for controlling how the property appears in a Property Grid window.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.GraphModel.GraphObject
    Microsoft.VisualStudio.GraphModel.GraphMetadata

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

Syntax

'Declaration
Public Class GraphMetadata _
    Inherits GraphObject

public class GraphMetadata : GraphObject

public ref class GraphMetadata : public GraphObject

type GraphMetadata =  
    class 
        inherit GraphObject 
    end

public class GraphMetadata extends GraphObject

The GraphMetadata type exposes the following members.

Constructors

	Name	Description
	GraphMetadata(GraphMetadataOptions)	Construct a new GraphPropertyMetadata object.
	GraphMetadata(Object, GraphMetadataOptions)	Construct a new GraphPropertyMetadata object.
	GraphMetadata(String, String, String, GraphMetadataOptions)	Construct a new GraphPropertyMetadata object.

Top

Properties

	Name	Description
	Categories	Returns all categories. Never returns null. (Inherited from GraphObject.)
	CategoryCount	Returns the number of categories in the object. (Inherited from GraphObject.)
	Container	The object that this metadata describes.
	DefaultValue	Default value
	Description	Description of this GraphProperty
	DescriptiveCategoryLabel	Creates a delimited list of all category labels for this graph object. (Inherited from GraphObject.)
	DocumentSchema	Gets the document-local schema from the owner of this graph. (Inherited from GraphObject.)
	Group	For grouping this Property in a Property Grid.
	IsBrowsable	Return true if the property is browsable
	IsGroup	Gets whether this object is IsGroup. It looks for the GraphProperties.StyleForGroup. (Inherited from GraphObject.)
	IsPseudo	Gets whether this object is Pseudo. It looks for the GraphProperties.IsPseudo. (Inherited from GraphObject.)
	IsRemovable	Return true if the property is removable.
	IsSerializable	Return true if the property is serializable
	IsSharable	Return true if the property is sharable
	IsSubstitutable	Return true if the property is serializable and Aliasing is allowed
	IsUndoable	Return true if the property is undoable.
	IsWriteOnce	Return true if the property is write once
	Item	Property that gets or sets a property value. (Inherited from GraphObject.)
	Label	Displayable label of this GraphProperty
	Options	Flags that control how annotations of this metadata behaves.
	Owner	Gets the Graph object that this object belongs to. (Inherited from GraphObject.)
	Properties	Property that returns an enumeration of all annotations. The order of the enumeration is random. (Inherited from GraphObject.)
	PropertyCount	Property that returns a number of all annotations. (Inherited from GraphObject.)
	PropertyKeys	Property that returns an enumeration of all annotation keys. The order of the enumeration is random. (Inherited from GraphObject.)
	PropertyValues	Property that returns an enumeration of all annotation values. The order of the enumeration is random. (Inherited from GraphObject.)
	Visibility	Helper property to get/set visibility property of a GraphObject. (Inherited from GraphObject.)

Top

Methods

	Name	Description
	AddCategory	Adds a category to the object. (Inherited from GraphObject.)
	AsNode	Converts the GraphObject to a GraphNode. If this is a GraphGroup, the inner node is returned. For types other than GraphNode/Group, null is returned. (Inherited from GraphObject.)
	ClearCategories	Remove all categories from this object. (Inherited from GraphObject.)
	ClearValue(GraphProperty)	Removes the value of the specified property. (Inherited from GraphObject.)
	Copy	Make a copy of the graph metadata.
	CopyCategories	Copies any new categories from the given object, keeping existing categories. (Inherited from GraphObject.)
	CopyProperties	Copies any new properties from the given object, keeping existing property values unchanged. (Inherited from GraphObject.)
	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 the default hash function. (Inherited from Object.)
	GetMetaObject	(Inherited from GraphObject.)
	GetSchemaValue	(Overrides GraphObject.GetSchemaValue(GraphProperty).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue(String)	Gets the value of the specified property. (Inherited from GraphObject.)
	GetValue(GraphProperty)	Gets the value of the specified annotation. (Inherited from GraphObject.)
	GetValue<T>(GraphProperty, Graph)	Gets the value of the specified property. (Inherited from GraphObject.)
	GetValue<T>(GraphProperty, T)	Gets the value of the specified annotation. If property is not set, we return the default value that the caller passed to this method. (Inherited from GraphObject.)
	GetValue<T>(GraphProperty, Graph, GraphCategory%)	Gets the value of the specified property, and also returns the category that this property value was inherited from, if any. (Inherited from GraphObject.)
	GetValueAsString	Returns the given property as a string that uses the given culture. (Inherited from GraphObject.)
	HasCategory(String)	Returns true if the object has the given category. (Inherited from GraphObject.)
	HasCategory(GraphCategory)	Returns true if the object has the given category. (Inherited from GraphObject.)
	HasCategory(IEnumerable<GraphCategory>)	Returns true if the object has any of the given categories. (Inherited from GraphObject.)
	HasCategoryInSet	Determines whether the given set of categories applies to this object. (Inherited from GraphObject.)
	HasLocalValue	Returns true if the specified property exists on this object with no category inheritance check. (Inherited from GraphObject.)
	HasValue(String)	Find out whether the object has a value for the specified property. (Inherited from GraphObject.)
	HasValue(GraphProperty)	Returns true if the specified annotation exists. (Inherited from GraphObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnCategoryChanged	(Inherited from GraphObject.)
	OnPropertyChanged(String)	Raises a PropertyChangd event for the named property. (Inherited from GraphObject.)
	OnPropertyChanged(GraphProperty)	Raises a PropertyChangd event for the given GraphProperty. (Inherited from GraphObject.)
	RemoveCategory	Removes the category of this object. (Inherited from GraphObject.)
	SetValue(String, Object)	Adds an annotation, using the given key, type, and value. (Inherited from GraphObject.)
	SetValue<T>(GraphProperty, T)	Sets the value of the given property. If the property already exists, its value is overwritten unless the annotation flags prevent otherwise. (Inherited from GraphObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WrapGraphObject	Modifies the current graph object to share the same property and categories as the given graph object. The wrapper and wrappee graph objects will always have identical sets of properties and categories. (Inherited from GraphObject.)

Top

Events

	Name	Description
	CategoryChanged	(Inherited from GraphObject.)
	PropertyChanged	(Inherited from GraphObject.)

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.GraphModel Namespace