PageInfos Class |
A collection of PageInfo objects. The primary use of this collection is the collection
of all available pages in an application, accessible from the IAppContext object via PageInfos.
Pages in the collection are uniquely identified by their MOP.
Inheritance HierarchyNamespace: NetQuarry
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
SyntaxThe PageInfos type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PageInfos |
Standard constructor.
|
| PageInfos(Int32) |
Standard constructor, with initial capacity.
|
Properties| Name | Description | |
|---|---|---|
 | Count |
The number of elements actually contained in the ArrayList.
(Inherited from EAPCollectionBase.) |
| IsFixedSize |
true if the ArrayList has a fixed size; otherwise, false. The default is false.
(Inherited from EAPCollectionBase.) |
| IsReadOnly |
Returns true if the collection is read-only. (Default is false)
(Inherited from EAPCollectionBase.) |
| IsSynchronized |
true if access to the internal ArrayList is synchronized (thread-safe); otherwise, false. The default is false.
(Inherited from EAPCollectionBase.) |
| ItemInt32 |
Pages collection indexer, by 0-based index.
|
| ItemString |
Pages collection indexer, by MOP.
Use Find(String, PageFindType) to look up pages by other values such as ID.
|
| Properties |
The Properties collection for the collection.
|
| SyncRoot |
An object that can be used to synchronize access to the ArrayList.
(Inherited from EAPCollectionBase.) |
| TextItems |
The TextItems localized text for the collection.
|
| Version |
The version of this object's assembly.
|
Methods| Name | Description | |
|---|---|---|
| Add(PageInfo) |
Add a PageInfo object to the collection.
|
 | Add(String, Object) |
Adds an object to the collection. Override. This method simply calls the Add method with CollectionAddFlags.replace as the flags.
(Inherited from EAPCollectionBase.) |
| Add(String, Object, CollectionAddFlags) |
Adds an item to the collection
(Inherited from EAPCollectionBase.) |
| AddAt |
Adds an item to the collection at the specified index. To append an item use -1 or
the collection item count as the index.
(Inherited from EAPCollectionBase.) |
| Clear |
Clears the collection
(Inherited from EAPCollectionBase.) |
| Clone(IAppContext) |
The Clone method creates a copy of this PageInfos collection.
|
| Clone(IAppContext, CloneStatusAttrs) |
The Clone method creates a copy of this PageInfos collection.
|
| Contains |
Determines whether an element is in the collection.
(Inherited from EAPCollectionBase.) |
| ContainsKey |
Checks for the existence of an item in the hashtable
(Inherited from EAPCollectionBase.) |
| CopyTo |
Copies the entire ArrayList to a compatible one-dimensional Array, starting at the beginning of the target array.
(Inherited from EAPCollectionBase.) |
| Equals | (Inherited from Object.) |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| Find |
Locates and returns the object by searching through the collection based on the provided PageFindType.
Note that the collection's native index is MOP.
|
| GetEnumerator |
Returns an enumerator that can iterate through the ArrayList.
(Inherited from EAPCollectionBase.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetItem(Int32) |
Returns an item that matches the specified string index
(Inherited from EAPCollectionBase.) |
| GetItem(String) |
Returns an item that matches the specified string index
(Inherited from EAPCollectionBase.) |
| GetItemName |
Returns the name of the item. Then name of items in this collection is the MOP.
(Overrides EAPCollectionBaseGetItemName(Object).) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf |
Returns the zero-based index of the first occurrence of an object in the internal ArrayList or in a portion of it.
(Inherited from EAPCollectionBase.) |
| IndexOfKey |
Returns the index of the item in the collection (by key)
(Inherited from EAPCollectionBase.) |
| Insert |
Inserts an element into the internal ArrayList at the specified index
(Inherited from EAPCollectionBase.) |
| IsAvailable |
Gets whether or not the specified MOP is available to the current user.
|
| IsMarkedForDeletion |
Determines if this element is marked for deletion. Note that this base implementation
must be overridden in order to support RemoveMarkedItems() for a partular collection.
(Inherited from EAPCollectionBase.) |
 | IsMOP |
Returns true if the specified string is a properly formed MOP.
|
| IsPermissionedOut |
Gets whether or not the specified MOP was permissioned out.
|
| IsTenantSpecific |
Gets whether or not the specified page is tenant-specific.
|
| IsTypeOK |
Verifies the item is a PageInfo object.
(Overrides EAPCollectionBaseIsTypeOK(Object).) |
| Load(IAppContext) |
Loads the pages from the metadata database. Note that the collection is cleared first.
|
| Load(IAppContext, IDatabase) |
Loads the pages from the specified metadata database. Note that the collection is cleared first.
|
| Load(IAppContext, IDatabase, Boolean) |
Loads the pages from the specified metadata database, optionally ignoring permissions (not generally recommended). Note that the collection is cleared first.
|
| LoadTenantPages |
Load the tenant-specific pages (pages marked with TenantSpecific) for the current Tenant.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PrepareForCache |
Prepares this object for cache
|
| RecalcHash |
Recalculates the internal hash
(Inherited from EAPCollectionBase.) |
| Reload(IAppContext, String) |
Reload the meta-data for the specified MOP. Note that this will flush the cache for that MOP.
|
| Reload(IAppContext, String, Boolean) |
Reload the meta-data for the specified MOP. Note that this will flush the cache for that MOP.
|
| Remove(Object) |
Removes the first occurrence of a specific object from the collection
(Inherited from EAPCollectionBase.) |
| Remove(String) |
Remove the specified item from the collection.
(Inherited from EAPCollectionBase.) |
| RemoveAt |
Removes the element at the specified index
(Inherited from EAPCollectionBase.) |
| RemoveMarkedItems |
Removes the properties marked for deletion.
(Inherited from EAPCollectionBase.) |
| RemoveRange |
Removes the element at the specified index
(Inherited from EAPCollectionBase.) |
| SetItem(Int32, Object) |
Sets an item's value at the specified index.
(Inherited from EAPCollectionBase.) |
| SetItem(String, Object) |
Sets an item's value at the string index indicated by the parameters.
(Inherited from EAPCollectionBase.) |
| Sort(Boolean) |
Sort the list by its key value.
(Inherited from EAPCollectionBase.) |
| Sort(IComparer) |
Sort the collection using the provided comparer.
(Inherited from EAPCollectionBase.) |
| ToString | (Inherited from Object.) |
| Truncate |
Truncate the array starting at the specified index.
(Inherited from EAPCollectionBase.) |
| Unload |
Called when the collection is cleared allowing a derived class to clean up.
(Inherited from EAPCollectionBase.) |
Extension Methods| Name | Description | |
|---|---|---|
 | EqualValue |
Determines if the object value is equal to another object. If the two objects are null, then this returns true.
There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways).
If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.) |
Remarks
When the pages are loaded from the database
pages marked as Disabled are not loaded (though Disabled pages could be present in the collection if the
Disabled attribute is later set programmatically). Where meta-data includes pages with the same MOP, only the page with
the highest Priority is loaded. In addition, pages are loaded only if the Permissions are
appropriate for the current user and, if the page is marked TenantSpecific, if the page is available to the current
user's Tenant.
RemarksWarning: For performance reasons the PageInfo objects in the PageInfos collection are
global objects that persist across requests for the current user, and even for other users having similar roles. For this
reason you should not modify these global objects programmatically unless the intent it to have a truly global change.
As each page is initialized a reference to these global objects is set as the page's PageInfo value and so each page's
PageInfo object is global as well and should not be modified. Clonging the page's PageInfo object and
setting it back on the page sets the page up to use a non-global instance of the PageInfo object that exists only for
the current request and may be freely modified without affecting other requests.
See Also