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.

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

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

public class GraphMetadata : GraphObject

The GraphMetadata type exposes the following members.

  NameDescription
Public methodGraphMetadata(GraphMetadataOptions)Construct a new GraphPropertyMetadata object.
Public methodGraphMetadata(Object, GraphMetadataOptions)Construct a new GraphPropertyMetadata object.
Public methodGraphMetadata(String, String, String, GraphMetadataOptions)Construct a new GraphPropertyMetadata object.
Top

  NameDescription
Public propertyCategoriesReturns all categories. Never returns null. (Inherited from GraphObject.)
Public propertyCategoryCountReturns the number of categories in the object. (Inherited from GraphObject.)
Public propertyContainerThe object that this metadata describes.
Public propertyDefaultValueDefault value
Public propertyDescriptionDescription of this GraphProperty
Public propertyDescriptiveCategoryLabelCreates a delimited list of all category labels for this graph object. (Inherited from GraphObject.)
Public propertyDocumentSchemaGets the document-local schema from the owner of this graph. (Inherited from GraphObject.)
Public propertyGroupFor grouping this Property in a Property Grid.
Public propertyIsBrowsableReturn true if the property is browsable
Public propertyIsGroupGets whether this object is IsGroup. It looks for the GraphProperties.StyleForGroup. (Inherited from GraphObject.)
Public propertyIsPseudoGets whether this object is Pseudo. It looks for the GraphProperties.IsPseudo. (Inherited from GraphObject.)
Public propertyIsRemovableReturn true if the property is removable.
Public propertyIsSerializableReturn true if the property is serializable
Public propertyIsSharableReturn true if the property is sharable
Public propertyIsSubstitutableReturn true if the property is serializable and Aliasing is allowed
Public propertyIsUndoableReturn true if the property is undoable.
Public propertyIsWriteOnceReturn true if the property is write once
Public propertyItemProperty that gets or sets a property value. (Inherited from GraphObject.)
Public propertyLabelDisplayable label of this GraphProperty
Public propertyOptionsFlags that control how annotations of this metadata behaves.
Public propertyOwnerGets the Graph object that this object belongs to. (Inherited from GraphObject.)
Public propertyPropertiesProperty that returns an enumeration of all annotations. The order of the enumeration is random. (Inherited from GraphObject.)
Public propertyPropertyCountProperty that returns a number of all annotations. (Inherited from GraphObject.)
Public propertyPropertyKeysProperty that returns an enumeration of all annotation keys. The order of the enumeration is random. (Inherited from GraphObject.)
Public propertyPropertyValuesProperty that returns an enumeration of all annotation values. The order of the enumeration is random. (Inherited from GraphObject.)
Public propertyVisibilityHelper property to get/set visibility property of a GraphObject. (Inherited from GraphObject.)
Top

  NameDescription
Public methodAddCategoryAdds a category to the object. (Inherited from GraphObject.)
Public methodAsNodeConverts 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.)
Public methodClearCategoriesRemove all categories from this object. (Inherited from GraphObject.)
Public methodClearValue(GraphProperty)Removes the value of the specified property. (Inherited from GraphObject.)
Public methodCopyMake a copy of the graph metadata.
Public methodCopyCategoriesCopies any new categories from the given object, keeping existing categories. (Inherited from GraphObject.)
Public methodCopyPropertiesCopies any new properties from the given object, keeping existing property values unchanged. (Inherited from GraphObject.)
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetMetaObject (Inherited from GraphObject.)
Protected methodGetSchemaValue (Overrides GraphObject.GetSchemaValue(GraphProperty).)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValue(String)Gets the value of the specified property. (Inherited from GraphObject.)
Public methodGetValue(GraphProperty)Gets the value of the specified annotation. (Inherited from GraphObject.)
Public methodGetValue<T>(GraphProperty, Graph)Gets the value of the specified property. (Inherited from GraphObject.)
Public methodGetValue<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.)
Public methodGetValue<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.)
Public methodGetValueAsStringReturns the given property as a string that uses the given culture. (Inherited from GraphObject.)
Public methodHasCategory(String)Returns true if the object has the given category. (Inherited from GraphObject.)
Public methodHasCategory(GraphCategory)Returns true if the object has the given category. (Inherited from GraphObject.)
Public methodHasCategory(IEnumerable<GraphCategory>)Returns true if the object has any of the given categories. (Inherited from GraphObject.)
Public methodHasCategoryInSetDetermines whether the given set of categories applies to this object. (Inherited from GraphObject.)
Public methodHasLocalValueReturns true if the specified property exists on this object with no category inheritance check. (Inherited from GraphObject.)
Public methodHasValue(String)Find out whether the object has a value for the specified property. (Inherited from GraphObject.)
Public methodHasValue(GraphProperty)Returns true if the specified annotation exists. (Inherited from GraphObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnCategoryChanged (Inherited from GraphObject.)
Public methodOnPropertyChanged(String)Raises a PropertyChangd event for the named property. (Inherited from GraphObject.)
Public methodOnPropertyChanged(GraphProperty)Raises a PropertyChangd event for the given GraphProperty. (Inherited from GraphObject.)
Public methodRemoveCategoryRemoves the category of this object. (Inherited from GraphObject.)
Public methodSetValue(String, Object)Adds an annotation, using the given key, type, and value. (Inherited from GraphObject.)
Public methodSetValue<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.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodWrapGraphObjectModifies 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

  NameDescription
Public eventCategoryChanged (Inherited from GraphObject.)
Public eventPropertyChanged (Inherited from GraphObject.)
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft