mcs/class/System.Windows.Forms/Documentation/en/System.Windows.Forms/FileDialogCustomPlacesCollection.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="FileDialogCustomPlacesCollection" FullName="System.Windows.Forms.FileDialogCustomPlacesCollection">
   3   <TypeSignature Language="C#" Value="public class FileDialogCustomPlacesCollection : System.Collections.ObjectModel.Collection&lt;System.Windows.Forms.FileDialogCustomPlace&gt;" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Collections.ObjectModel.Collection&lt;System.Windows.Forms.FileDialogCustomPlace&gt;</BaseTypeName>
  10     <BaseTypeArguments>
  11       <BaseTypeArgument TypeParamName="T">System.Windows.Forms.FileDialogCustomPlace</BaseTypeArgument>
  12     </BaseTypeArguments>
  13   </Base>
  14   <Interfaces />
  15   <Docs>
  16     <remarks>
  17       <attribution license="cc4" from="Microsoft" modified="false" />
  18       <para>On winxp or winxpsvr, this class does not have any effect.</para>
  19     </remarks>
  20     <summary>
  21       <attribution license="cc4" from="Microsoft" modified="false" />
  22       <para>Represents a collection of wiprlhext custom places for the <see cref="T:System.Windows.Forms.FileDialog" /> class.</para>
  23     </summary>
  24   </Docs>
  25   <Members>
  26     <Member MemberName=".ctor">
  27       <MemberSignature Language="C#" Value="public FileDialogCustomPlacesCollection ();" />
  28       <MemberType>Constructor</MemberType>
  29       <AssemblyInfo>
  30         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  31       </AssemblyInfo>
  32       <Parameters />
  33       <Docs>
  34         <remarks>To be added.</remarks>
  35         <summary>
  36           <attribution license="cc4" from="Microsoft" modified="false" />
  37           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.FileDialogCustomPlacesCollection" /> class. </para>
  38         </summary>
  39       </Docs>
  40     </Member>
  41     <Member MemberName="Add">
  42       <MemberSignature Language="C#" Value="public void Add (Guid knownFolderGuid);" />
  43       <MemberType>Method</MemberType>
  44       <AssemblyInfo>
  45         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  46       </AssemblyInfo>
  47       <ReturnValue>
  48         <ReturnType>System.Void</ReturnType>
  49       </ReturnValue>
  50       <Parameters>
  51         <Parameter Name="knownFolderGuid" Type="System.Guid" />
  52       </Parameters>
  53       <Docs>
  54         <remarks>
  55           <attribution license="cc4" from="Microsoft" modified="false" />
  56           <para>The folder is added to custom places only for a particular <see cref="T:System.Windows.Forms.FileDialog" /> and is not a system or application wide change.</para>
  57           <para>The folders are positioned in the custom places in the order that they are added to the <see cref="T:System.Windows.Forms.FileDialog" />. The last one added will be at the top. If you add a custom place to the collection that does not exist on the computer running the application, the custom place will not be shown. GUIDs are case-insensitive. For a list of the available wiprlhext Known Folders, see <format type="text/html"><a href="d8d8b544-8b4d-4da5-ba3a-b05e93244778">Known Folder Guids for File Dialog Custom Places</a></format> or the KnownFolders.h file in the winSDK.</para>
  58         </remarks>
  59         <summary>
  60           <attribution license="cc4" from="Microsoft" modified="false" />
  61           <para>Adds a custom place to the <see cref="T:System.Windows.Forms.FileDialogCustomPlacesCollection" /> collection.</para>
  62         </summary>
  63         <param name="knownFolderGuid">
  64           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Guid" /> that represents a wiprlhext Known Folder. </param>
  65       </Docs>
  66     </Member>
  67     <Member MemberName="Add">
  68       <MemberSignature Language="C#" Value="public void Add (string path);" />
  69       <MemberType>Method</MemberType>
  70       <AssemblyInfo>
  71         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  72       </AssemblyInfo>
  73       <ReturnValue>
  74         <ReturnType>System.Void</ReturnType>
  75       </ReturnValue>
  76       <Parameters>
  77         <Parameter Name="path" Type="System.String" />
  78       </Parameters>
  79       <Docs>
  80         <remarks>
  81           <attribution license="cc4" from="Microsoft" modified="false" />
  82           <para>The folder is added to custom places only for a particular <see cref="T:System.Windows.Forms.FileDialog" /> and is not a system or application wide change.</para>
  83           <para>The folders are positioned in the custom places in the order that they are added to the <see cref="T:System.Windows.Forms.FileDialog" />. The last one added will be at the top. </para>
  84         </remarks>
  85         <summary>
  86           <attribution license="cc4" from="Microsoft" modified="false" />
  87           <para>Adds a custom place to the <see cref="T:System.Windows.Forms.FileDialogCustomPlacesCollection" /> collection.</para>
  88         </summary>
  89         <param name="path">
  90           <attribution license="cc4" from="Microsoft" modified="false" />A folder path to the custom place.</param>
  91       </Docs>
  92     </Member>
  93   </Members>
  94 </Type>