mcs/class/System.ComponentModel.Composition/src/ComponentModel/System/ComponentModel/Composition/Primitives/ICompositionElement.cs

   1 // -----------------------------------------------------------------------\r
   2 // Copyright (c) Microsoft Corporation.  All rights reserved.\r
   3 // -----------------------------------------------------------------------\r
   4 using System;\r
   5 \r
   6 namespace System.ComponentModel.Composition.Primitives\r
   7 {\r
   8     /// <summary>\r
   9     ///     Represents an element that participates in composition.\r
  10     /// </summary>\r
  11     public interface ICompositionElement\r
  12     {\r
  13         /// <summary>\r
  14         ///     Gets the display name of the composition element.\r
  15         /// </summary>\r
  16         /// <value>\r
  17         ///     A <see cref="String"/> containing a human-readable display name of the <see cref="ICompositionElement"/>.\r
  18         /// </value>\r
  19         /// <remarks>\r
  20         ///     <note type="implementnotes">\r
  21         ///         Implementors of this property should never return <see langword="null"/> or an empty \r
  22         ///         string ("").\r
  23         ///     </note>\r
  24         /// </remarks>\r
  25         string DisplayName\r
  26         {\r
  27             get;\r
  28         }\r
  29 \r
  30         /// <summary>\r
  31         ///     Gets the composition element from which the current composition element\r
  32         ///     originated.\r
  33         /// </summary>\r
  34         /// <value>\r
  35         ///     A <see cref="ICompositionElement"/> from which the current \r
  36         ///     <see cref="ICompositionElement"/> originated, or <see langword="null"/> \r
  37         ///     if the <see cref="ICompositionElement"/> is the root composition element.\r
  38         /// </value>\r
  39         ICompositionElement Origin\r
  40         {\r
  41             get;\r
  42         }\r
  43     }\r
  44 }