Share via

AdornerPlacementCollection Class

  • Article

Enables precise placement of adorners within an AdornerPanel.

Inheritance Hierarchy

System.Object
  System.Collections.ObjectModel.Collection<IAdornerPlacement>
    System.Collections.ObjectModel.ObservableCollection<IAdornerPlacement>
      Microsoft.Windows.Design.Interaction.AdornerPlacementCollection

Namespace:  Microsoft.Windows.Design.Interaction
Assembly:  Microsoft.Windows.Design.Interaction (in Microsoft.Windows.Design.Interaction.dll)

Syntax

'Declaration
Public Class AdornerPlacementCollection _
    Inherits ObservableCollection(Of IAdornerPlacement)

public class AdornerPlacementCollection : ObservableCollection<IAdornerPlacement>

public ref class AdornerPlacementCollection : public ObservableCollection<IAdornerPlacement^>

type AdornerPlacementCollection =  
    class
        inherit ObservableCollection<IAdornerPlacement>
    end

public class AdornerPlacementCollection extends ObservableCollection<IAdornerPlacement>

The AdornerPlacementCollection type exposes the following members.

Constructors

  Name Description
Public method AdornerPlacementCollection Initializes a new instance of the AdornerPlacementCollection class.

Top

Properties

  Name Description
Public property Count Gets the number of elements actually contained in the Collection<T>. (Inherited from Collection<IAdornerPlacement>.)
Public property Item Gets or sets the element at the specified index. (Inherited from Collection<IAdornerPlacement>.)
Protected property Items Gets a IList<T> wrapper around the Collection<T>. (Inherited from Collection<IAdornerPlacement>.)

Top

Methods

  Name Description
Public method Add Adds an object to the end of the Collection<T>. (Inherited from Collection<IAdornerPlacement>.)
Protected method BlockReentrancy Disallows reentrant attempts to change this collection. (Inherited from ObservableCollection<IAdornerPlacement>.)
Protected method CheckReentrancy Checks for reentrant attempts to change this collection. (Inherited from ObservableCollection<IAdornerPlacement>.)
Public method Clear Removes all elements from the Collection<T>. (Inherited from Collection<IAdornerPlacement>.)
Protected method ClearItems Removes all items from the collection. (Inherited from ObservableCollection<IAdornerPlacement>.)
Public method Contains Determines whether an element is in the Collection<T>. (Inherited from Collection<IAdornerPlacement>.)
Public method CopyTo Copies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<IAdornerPlacement>.)
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an enumerator that iterates through the Collection<T>. (Inherited from Collection<IAdornerPlacement>.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Searches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<IAdornerPlacement>.)
Public method Insert Inserts an element into the Collection<T> at the specified index. (Inherited from Collection<IAdornerPlacement>.)
Protected method InsertItem Inserts an item into the collection at the specified index. (Inherited from ObservableCollection<IAdornerPlacement>.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Move Moves the item at the specified index to a new location in the collection. (Inherited from ObservableCollection<IAdornerPlacement>.)
Protected method MoveItem Moves the item at the specified index to a new location in the collection. (Inherited from ObservableCollection<IAdornerPlacement>.)
Protected method OnCollectionChanged Raises the CollectionChanged event with the provided arguments. (Inherited from ObservableCollection<IAdornerPlacement>.)
Protected method OnPropertyChanged Raises the PropertyChanged event with the provided arguments. (Inherited from ObservableCollection<IAdornerPlacement>.)
Public method PositionRelativeToAdornerHeight(Double, Double) Adds a placement term that positions the adorner panel relative to the adorner's height.
Public method PositionRelativeToAdornerHeight(Double, Double, DependencyObject) Adds a placement term that positions the adorner panel relative to the specified adorner's height.
Public method PositionRelativeToAdornerWidth(Double, Double) Adds a placement term that positions the adorner panel relative to the adorner's width.
Public method PositionRelativeToAdornerWidth(Double, Double, DependencyObject) Adds a placement term that positions the adorner panel relative to the specified adorner's width.
Public method PositionRelativeToContentHeight(Double, Double) Adds a placement term that positions the adorner panel relative to the adorned content's height.
Public method PositionRelativeToContentHeight(Double, Double, ViewItem) Adds a placement term to this group that positions the adorner panel relative to the content's height.
Public method PositionRelativeToContentWidth(Double, Double) Adds a placement term that positions the adorner panel relative to the adorned content's width.
Public method PositionRelativeToContentWidth(Double, Double, ViewItem) Adds a placement term to this group that positions the adorner panel relative to the content's width.
Public method Remove Removes the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<IAdornerPlacement>.)
Public method RemoveAt Removes the element at the specified index of the Collection<T>. (Inherited from Collection<IAdornerPlacement>.)
Protected method RemoveItem Removes the item at the specified index of the collection. (Inherited from ObservableCollection<IAdornerPlacement>.)
Protected method SetItem Replaces the element at the specified index. (Inherited from ObservableCollection<IAdornerPlacement>.)
Public method SizeRelativeToAdornerDesiredHeight(Double, Double) Adds a placement term that sizes the adorner panel relative to the adorner's desired height.
Public method SizeRelativeToAdornerDesiredHeight(Double, Double, DependencyObject) Add a placement term that sizes the adorner panel relative to the specified adorner's desired height.
Public method SizeRelativeToAdornerDesiredWidth(Double, Double) Adds a placement term that sizes the adorner panel relative to the adorner's desired width.
Public method SizeRelativeToAdornerDesiredWidth(Double, Double, DependencyObject) Adds a placement term that sizes the adorner panel relative to the specified adorner's desired width.
Public method SizeRelativeToContentHeight(Double, Double) Adds a placement term that sizes the adorner panel relative to the adorned content's height.
Public method SizeRelativeToContentHeight(Double, Double, ViewItem) Adds a placement term to this group that sizes the adorner panel relative to the content's height.
Public method SizeRelativeToContentWidth(Double, Double) Adds a placement term that sizes the adorner panel relative to the adorned content's width.
Public method SizeRelativeToContentWidth(Double, Double, ViewItem) Adds a placement term to this group that sizes the adorner panel relative to the content's width.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event CollectionChanged Occurs when an item is added, removed, changed, moved, or the entire list is refreshed. (Inherited from ObservableCollection<IAdornerPlacement>.)
Protected event PropertyChanged Occurs when a property value changes. (Inherited from ObservableCollection<IAdornerPlacement>.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IList.Add Adds an item to the IList. (Inherited from Collection<IAdornerPlacement>.)
Explicit interface implemetationPrivate method IList.Contains Determines whether the IList contains a specific value. (Inherited from Collection<IAdornerPlacement>.)
Explicit interface implemetationPrivate method ICollection.CopyTo Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from Collection<IAdornerPlacement>.)
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Returns an enumerator that iterates through a collection. (Inherited from Collection<IAdornerPlacement>.)
Explicit interface implemetationPrivate method IList.IndexOf Determines the index of a specific item in the IList. (Inherited from Collection<IAdornerPlacement>.)
Explicit interface implemetationPrivate method IList.Insert Inserts an item into the IList at the specified index. (Inherited from Collection<IAdornerPlacement>.)
Explicit interface implemetationPrivate property IList.IsFixedSize Gets a value indicating whether the IList has a fixed size. (Inherited from Collection<IAdornerPlacement>.)
Explicit interface implemetationPrivate property ICollection<T>.IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. (Inherited from Collection<IAdornerPlacement>.)
Explicit interface implemetationPrivate property IList.IsReadOnly Gets a value indicating whether the IList is read-only. (Inherited from Collection<IAdornerPlacement>.)
Explicit interface implemetationPrivate property ICollection.IsSynchronized Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from Collection<IAdornerPlacement>.)
Explicit interface implemetationPrivate property IList.Item Gets or sets the element at the specified index. (Inherited from Collection<IAdornerPlacement>.)
Explicit interface implemetationPrivate event INotifyPropertyChanged.PropertyChanged Occurs when a property value changes. (Inherited from ObservableCollection<IAdornerPlacement>.)
Explicit interface implemetationPrivate method IList.Remove Removes the first occurrence of a specific object from the IList. (Inherited from Collection<IAdornerPlacement>.)
Explicit interface implemetationPrivate property ICollection.SyncRoot Gets an object that can be used to synchronize access to the ICollection. (Inherited from Collection<IAdornerPlacement>.)

Top

Remarks

Use the AdornerPlacementCollection class to specify the location, size, and scaling properties of an AdornerPanel relative to the control it adorns.

Call the PositionRelativeToAdornerHeight and PositionRelativeToAdornerWidth methods to place the AdornerPanel relative to its adorner control's height and width.

Call the SizeRelativeToAdornerDesiredWidth and SizeRelativeToContentHeight methods to size the AdornerPanel relative to its adorner control's size.

Call the corresponding content-based methods to size and position the AdornerPanel relative to the adorned content.

Calls to the size and position methods are cumulative. The following code example shows two calls to the PositionRelativeToAdornerHeight method, which have the effect of placing the AdornerPanel above the adorned control with a y-axis offset equal to the height of the adorner plus five pixels.

Examples

The following code example shows how to use an AdornerPlacementCollection to specify the position of an adorner in an adorner panel. For more information, see Walkthrough: Creating a Design-time Adorner.

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.Windows.Design.Interaction Namespace

AdornerPanel

PrimarySelectionAdornerProvider

Other Resources

Walkthrough: Creating a Design-time Adorner

Walkthrough: Implementing a Rail Inside a Control

Adorner Architecture