[JEDI.NET-commits] docs Jedi.Collections.xml,1.2,1.3

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/jedidotnet/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv5719/docs

Modified Files:
	Jedi.Collections.xml 
Log Message:
Partially documented

Index: Jedi.Collections.xml
===================================================================
RCS file: /cvsroot/jedidotnet/docs/Jedi.Collections.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** Jedi.Collections.xml	24 Jun 2004 17:18:16 -0000	1.2
--- Jedi.Collections.xml	25 Jun 2004 12:28:06 -0000	1.3
***************
*** 7,55 ****
    <members>
      <member name="T:Jedi.Collections.NamespaceDoc">
!       <summary>
!       </summary>
!       <remarks>
!       </remarks>
!     </member>
      <member name="T:Jedi.Collections.IInlineCollection">
!       <summary>
!       </summary>
!     </member>
!     <member name="M:Jedi.Collections.IInlineCollection.AddItem(System.Object,System.Object)">
!       <summary>
!       </summary>
!       <param name="value">
!       </param>
!       <param name="addPropertyId">
!       </param>
!       <returns>
!       </returns>
!     </member>
!     <member name="M:Jedi.Collections.IInlineCollection.GetAllowRemove(System.Object)">
!       <summary>
!       </summary>
!       <param name="key">
!       </param>
!       <returns>
!       </returns>
!     </member>
!     <member name="M:Jedi.Collections.IInlineCollection.GetCollectionValue">
!       <summary>
!       </summary>
!       <returns>
!       </returns>
!     </member>
!     <member name="M:Jedi.Collections.IInlineCollection.GetItemProperties">
!       <summary>
!       </summary>
!       <returns>
!       </returns>
!     </member>
!     <member name="M:Jedi.Collections.IInlineCollection.GetNewItemProperties">
!       <summary>
        </summary>
-       <returns>
-       </returns>
      </member>
      <member name="M:Jedi.Collections.IInlineCollection.GetService(System.Type)">
        <summary>
--- 7,119 ----
    <members>
      <member name="T:Jedi.Collections.NamespaceDoc">
! 			<summary>
! 				The <b>Jedi.Collections</b> namespace defines several classes and interfaces that deal with collections. In
! 				addition it provides a mechanism that allows IList and IDictionary collections to be manipulated from within
! 				the PropertyGrid directly, without using additional design dialogs.
! 			</summary>
! 		</member>
      <member name="T:Jedi.Collections.IInlineCollection">
! 			<summary>
! 				Defines methods needed to allow a collection to be edited from within a
! 				<see cref="T:System.Windows.Forms.PropertyGrid" />.
        </summary>
      </member>
+ 		<member name="M:Jedi.Collections.IInlineCollection.AddItem(System.Object,System.Object)">
+ 			<summary>
+ 				Adds an item given a value and an property ID.
+ 			</summary>
+ 			<param name="value">
+ 				The value specified in the PropertyGrid to be added. For IDictionary collections this is usually the key value.
+ 			</param>
+ 			<param name="addPropertyId">
+ 				The ID of the property that requested the item to be added.
+ 			</param>
+ 		</member>
+ 		<member name="M:Jedi.Collections.IInlineCollection.GetAllowRemove(System.Object)">
+ 			<summary>
+ 				Determines if the given item can be removed.
+ 			</summary>
+ 			<param name="key">
+ 				Key of the item to remove. For IList collections this parameter represents the ordinal index in the list.
+ 			</param>
+ 			<returns>
+ 				<see langword="true" /> if the item can be removed from the collection; otherwise <see langword="false" />.
+ 			</returns>
+ 			<remarks>
+ 				<para>
+ 					This method is called directly from the ProperyGrid editor when an item's value is set to it's empty value as
+ 					specified at the moment the item's semi property is created.
+ 				</para>
+ 				<para>
+ 					Implementing classes can implement this method to perform checking whether an item can be removed or not. Some
+ 					collections may not allow the collections to grow smaller than a certain number or certain items are fixed and
+ 					should never be removed.
+ 				</para>
+ 			</remarks>
+ 		</member>
+ 		<member name="M:Jedi.Collections.IInlineCollection.GetCollectionValue">
+ 			<summary>
+ 				Retrieves the text to show in the PropertyGrid for the property that represents the collection.
+ 			</summary>
+ 			<returns>
+ 				A <see cref="T:System.String" /> representing the text to show as the value of the property that represents the
+ 				collection.
+ 			</returns>
+ 		</member>
+ 		<member name="M:Jedi.Collections.IInlineCollection.GetItemProperties">
+ 			<summary>
+ 				Retrieves a <see cref="System.ComponentModel.PropertyDescriptorCollection" /> contain a
+ 				<see cref="System.ComponentModel.PropertyDescriptor" /> for each item in the collection.
+ 			</summary>
+ 			<returns>
+ 				A <see cref="System.ComponentModel.PropertyDescriptorCollection" /> containing a
+ 				<see cref="System.ComponentModel.PropertyDescriptor" />for each item in the collection.
+ 			</returns>
+ 			<remarks>
+ 				<para>
+ 					The PropertyDescriptorCollection returned by this method will be used to generate the sub properties of the
+ 					property representing the collection. Under normal circumstances the collection will contain a
+ 					PropertyDescriptor for each item in the collection but implementers may choose to ignore certain items in the
+ 					collection, for instance fixed items that should not be changed or removed may be omitted from the collection.
+ 				</para>
+ 				<para>
+ 					<note type="implementnotes">
+ 						Implementers should use the <see cref="M:Jedi.Collections.InlineCollectionUtils.CreateItemProperty" />
+ 						method to create the PropertyDescriptor for each item in the collection which is to be edited. This method
+ 						allows to specify the value to use as an "empty" value (setting the property to this value will result in
+ 						the item being removed from the collection) as well as the index or key of the item in the collection.
+ 					</note>
+ 				</para>
+ 			</remarks>
+ 		</member>
+ 		<member name="M:Jedi.Collections.IInlineCollection.GetNewItemProperties">
+ 			<summary>
+ 				A <see cref="System.ComponentModel.PropertyDescriptorCollection" /> containing a
+ 				<see cref="System.ComponentModel.PropertyDescriptor" /> that will add new items to the collection.
+ 			</summary>
+ 			<returns>
+ 				A <see cref="System.ComponentModel.PropertyDescriptorCollection" /> containing a
+ 				<see cref="System.ComponentModel.PropertyDescriptor" /> that will add new items to the collection.
+ 			</returns>
+ 			<remarks>
+ 				<para>
+ 					The PropertyDescriptorCollection returned by this method will be used to generate sub properties of the
+ 					property representing the collection. Each property descriptor represents a way to add a new item.
+ 				</para>
+ 				<para>
+ 					By allowing multiple PropertyDescriptors it is possible to add various item types to a collection. Each
+ 					PropertyDescriptor contains an ID value. This value is send along in a call to
+ 					<see cref="M:Jedi.Collections.IInlineCollection.AddItem(System.Object,System.Object)" /> which will
+ 					add the indicated value, taking the property ID in account to determine what the value actually represents.
+ 				</para>
+ 				<para>
+ 					<note type="implementnotes">
+ 						Implementers should use the <see cref="M:Jedi.Collections.InlineCollectionUtils.CreateNewItemProperty" />
+ 						method to create the PropertyDescriptors needed. The method allows to specify the ID that is send to the
+ 						<see cref="M:Jedi.Collections.IInlineCollection.AddItem(System.Object,System.Object)" /> method.
+ 					</note>
+ 				</para>
+ 			</remarks>
+ 		</member>
      <member name="M:Jedi.Collections.IInlineCollection.GetService(System.Type)">
        <summary>
***************
*** 74,78 ****
        </param>
        <param name="addPropertyId">
!       </param>
        <returns>
        </returns>
--- 138,142 ----
        </param>
        <param name="addPropertyId">
! 			</param>
        <returns>
        </returns>
***************
*** 102,106 ****
      <member name="M:Jedi.Collections.InlineCollectionBase.GetItemEmptyValue(System.Int32)">
        <summary>
!       </summary>
        <param name="index">
        </param>
--- 166,170 ----
      <member name="M:Jedi.Collections.InlineCollectionBase.GetItemEmptyValue(System.Int32)">
        <summary>
! 			</summary>
        <param name="index">
        </param>
***************
*** 115,119 ****
        <returns>
        </returns>
!     </member>
      <member name="M:Jedi.Collections.InlineCollectionBase.GetItemName(System.Int32)">
        <summary>
--- 179,183 ----
        <returns>
        </returns>
! 		</member>
      <member name="M:Jedi.Collections.InlineCollectionBase.GetItemName(System.Int32)">
        <summary>
***************
*** 133,137 ****
        <summary>
        </summary>
!       <param name="index">
        </param>
        <returns>
--- 197,201 ----
        <summary>
        </summary>
! 			<param name="index">
        </param>
        <returns>
***************
*** 161,165 ****
        <summary>
        </summary>
!     </member>
      <member name="M:Jedi.Collections.InlineCollectionConverter.#ctor">
        <summary>
--- 225,229 ----
        <summary>
        </summary>
! 		</member>
      <member name="M:Jedi.Collections.InlineCollectionConverter.#ctor">
        <summary>
***************
*** 185,189 ****
        <!--
        this member is inherited and does not require documentation.
!       <summary>
        </summary>
        <param name="context">
--- 249,253 ----
        <!--
        this member is inherited and does not require documentation.
! 			<summary>
        </summary>
        <param name="context">
***************
*** 192,196 ****
        </param>
        <param name="attributes">
!       </param>
        <returns>
        </returns>-->
--- 256,260 ----
        </param>
        <param name="attributes">
! 			</param>
        <returns>
        </returns>-->
***************
*** 220,224 ****
        </summary>
        <param name="context">
!       </param>
        <param name="provider">
        </param>
--- 284,288 ----
        </summary>
        <param name="context">
! 			</param>
        <param name="provider">
        </param>
***************
*** 251,283 ****
        <returns>
        </returns>
!     </member>
!     <member name="M:Jedi.Collections.InlineCollectionUtils.CreateItemProperty(System.Reflection.PropertyInfo,System.Object,System.String,System.String,System.Object,System.Object,System.Boolean)">
!       <summary>
!       </summary>
!       <param name="info">
!       </param>
!       <param name="component">
!       </param>
!       <param name="name">
!       </param>
!       <param name="description">
!       </param>
!       <param name="index">
!       </param>
!       <param name="emptyValue">
!       </param>
!       <param name="ignoreDefaultProperty">
!       </param>
!       <returns>
!       </returns>
!     </member>
!     <member name="M:Jedi.Collections.InlineCollectionUtils.CreateItemProperty(System.Type,System.Attribute[],System.Object,System.String,System.String,System.Object,System.Object)">
!       <summary>
!       </summary>
!       <param name="propertyType">
!       </param>
!       <param name="attributes">
!       </param>
!       <param name="component">
        </param>
        <param name="name">
--- 315,347 ----
        <returns>
        </returns>
! 		</member>
! 		<member name="M:Jedi.Collections.InlineCollectionUtils.CreateItemProperty(System.Reflection.PropertyInfo,System.Object,System.String,System.String,System.Object,System.Object,System.Boolean)">
! 			<summary>
! 			</summary>
! 			<param name="info">
! 			</param>
! 			<param name="component">
! 			</param>
! 			<param name="name">
! 			</param>
! 			<param name="description">
! 			</param>
! 			<param name="index">
! 			</param>
! 			<param name="emptyValue">
! 			</param>
! 			<param name="ignoreDefaultProperty">
! 			</param>
! 			<returns>
! 			</returns>
! 		</member>
! 		<member name="M:Jedi.Collections.InlineCollectionUtils.CreateItemProperty(System.Type,System.Attribute[],System.Object,System.String,System.String,System.Object,System.Object)">
! 			<summary>
! 			</summary>
! 			<param name="propertyType">
! 			</param>
! 			<param name="attributes">
! 			</param>
! 			<param name="component">
        </param>
        <param name="name">
***************
*** 325,329 ****
        <param name="componentType">
        </param>
!       <param name="propertyType">
        </param>
        <param name="attributes">
--- 389,393 ----
        <param name="componentType">
        </param>
! 			<param name="propertyType">
        </param>
        <param name="attributes">