XAML Diagnostics

Overview of the XAML Diagnostics technology.

To develop XAML Diagnostics, you need these headers:

• xamlom.h

For programming guidance for this technology, see:

• XAML Diagnostics

Enumerations

BaseValueSource Defines constants that specify where the effective value of a property was set.
MetadataBit Defines constants that are used to define the PropertyChainValue returned from XAML Diagnostics.
RenderTargetBitmapOptions Defines constants that specify what parts of the visual tree should be rendered.
ResourceType Defines constants that specify the type of a resource in a resource dictionary.
VisualElementState Defines constants that specify the state of an element in the visual tree.
VisualMutationType Defines constants that specify whether the element was added to or removed from the live visual tree.

Functions

AddChild Adds a child element to the collection at the specified index.
AddDictionaryItem Adds an item to a ResourceDictionary, and re-resolves all elements in the tree that reference a resource with the specified key.
AdviseVisualTreeChange Starts listening for changes to the visual tree.
ClearChildren Clears all child elements from the parent collection.
ClearProperty Clears the specified property on a XAML element.
CopyBytesTo Copies up to the specified maximum number of bytes from the given offset in the bitmap data into the caller’s buffer (pvBytes), and returns the number of bytes copied.
CreateInstance Creates an instance of any XAML runtime, enum, or primitive type.
GetApplication Gets an instance of the application.
GetBitmapDescription Gets a BitmapDescription that describes the bitmap data stored in the IBitmapData.
GetCollectionCount Gets the count of a collection.
GetCollectionElements Gets the elements in a collection.
GetDictionaryItem Gets an item from a ResourceDictionary.
GetDispatcher Gets the core dispatcher used to access elements on the UI thread.
GetEnums Gets an array of all the enums defined in the XAML runtime and the total count.
GetHandleFromIInspectable Gets an InstanceHandle representation of an IInspectable.
GetIInspectableFromHandle Gets the IInspectable from the XAML Diagnostics cache.
GetInitializationData Gets the initialization data passed in to XAML Diagnostics.
GetProperty Gets the effective value of the specified dependency property.
GetPropertyIndex Gets the property index for the specified property name.
GetPropertyValuesChain Gets an array of all the properties set on the element passed in, and an array of all the styles involved in setting the effective values of the properties.
GetSourceBitmapDescription Gets a BitmapDescription that describes the original format of the bitmap data stored in the IBitmapData.
GetStride Gets the stride of the data. This is the length in bytes of each row of the bitmap.
GetUiLayer Gets the visual diagnostics root that can be used to draw on for highlighting elements in the tree.
HitTest Gets all elements in the visual tree that fall within the specified rectangle.
InitializeXamlDiagnosticsEx Initializes a Xaml Diagnostics session. This is the entry point for any debugging tool using the XAML Diagnostic APIs.
OnElementStateChanged Communicates the state of an element in the visual tree when it changes.
OnVisualTreeChange Communicates the state of the visual tree when it changes.
RegisterInstance Adds an IInspectable to the XAML Diagnostics cache and returns the newly created InstanceHandle for the object.
RemoveChild Removes the child element from the specified index.
RemoveDictionaryItem Removes an item from a ResourceDictionary, and re-resolves all elements in the tree that reference a resource with the specified key.
RenderTargetBitmap Returns an image that represents the object described by handle, or returns an error if the object does not have or cannot provide such an image.
ReplaceResource Replaces an existing resource with a new one of the same type.
ResolveResource Resolves a resource for an element in the tree and applies the resource to the property provided by the specified property index.
SetProperty Sets a property value on a XAML element.
UnadviseVisualTreeChange Stops listening for changes to the visual tree.

Interfaces

IBitmapData Represents an image associated with a node in the visual tree.
IVisualTreeService Provides methods to manage a XAML visual tree.
IVisualTreeService2 Represents additional capabilities of an IVisualTreeService object.
IVisualTreeService3 Represents additional capabilities of an IVisualTreeService2 object.
IVisualTreeServiceCallback Communicates the state of the visual tree.
IVisualTreeServiceCallback2 Represents additional capabilities of an IVisualTreeServiceCallback object.
IXamlDiagnostics Represents a XAML Diagnostics session.

Structures

BitmapDescription Represents information about the bitmap stored in IBitmapData.
CollectionElementValue Represents an element in a collection.
EnumType Represents a XAML Runtime enumeration.
ParentChildRelation Associates a parent object with a child object.
PropertyChainSource Represents the source object (a Style) of a target type.
PropertyChainValue Represents a property defined on an element.
SourceInfo Represents information about an object’s XAML source document.
VisualElement Represents a XAML element in the Live Visual Tree in Microsoft Visual Studio.