Table B-1 shows the complete parentage of the CmsHttpContext class. The properties and methods listed in italics in the table are defined by the class in the column header and then inherited by the derived class(es) to the left. So, for instance, only Current, UserCacheKey, and ChannelItemIsVisible are coded in the CmsHttpContext class, whereas Equals, GetHashCode, GetType, and ToString are coded in the System. Object class and then inherited by the CmsContext class, the CmsAspContext class, and finally the CmsHttpContext class.
A handful of methods are inherited directly from System.Object. But the CmsContext class is the base class in which most of the CMS functionality is found.
Table B-2 defines all the members listed for CmsHttpContext in Table B-1.
Table B-2. CmsHttpContext Member Descriptions
CmsHttpContext | Description |
|---|
Public Properties |
Channel | Gets the Channel object representing the current channel. |
ChannelItem | Gets the ChannelItem for the current Web page. |
CmsQueryString | Gets a formatted QueryString string containing only the CMS-specific name/value pairs from the current QueryString. |
Current | Gets the CmsHttpContext for the current HttpRequest. |
IsDefaultGuestEnabled | Gets a value indicating whether guest user access is enabled for CMS. |
IsLoggedInAsGuest | Gets a value indicating whether the user is logged in as a guest. |
IsUsingTemplate | Gets a value indicating whether the current Web page is a Template. |
Mode | Gets the current PublishingMode for the current session. |
PlaceholderDefinitionTypes | Gets the collection of allowed PlaceholderDefinition types for a CMS site. |
Posting | Gets the Posting for the current Web page. |
RollbackOnSessionEnd | Gets or sets a value that indicates whether uncommitted changes are rolled back when the session ends. |
RootChannel | Gets the Channel at the root of the channel hierarchy. |
RootResourceGallery | Gets the ResourceGallery at the root of the resource hierarchy. |
RootTemplateGallery | Gets the TemplateGallery at the root of the template gallery hierarchy. |
Searches | Get the Searches object that is used to search the CMS site. |
ServerTime | Gets the current Coordinated Universal Time (UTC) of the CMS database server. |
SessionSettings | Gets the SessionSettings for the current session. |
TemporaryUpload | Gets the path of the temporary upload folder for Folder the CMS folder. |
User | Gets the User, which represents the currently logged in user. |
UserCacheKey | Gets a unique string for all users that have the same runtime browsing rights in the system. |
UserCanApprove | Gets a value indicating if the user has rights to approve postings in the CMS site. |
UserCanAuthor | Gets a value indicating if the user has rights to create and author postings. |
UserCanEditResources | Gets a value indicating if the user has rights to edit CmsHttpContext Parentage |
UserCanEditTemplates | Gets a value indicating if the user has rights to create and edit templates in the CMS site. |
UserCanModifySite | Gets a value indicating if the user has rights to make changes in the CMS site. |
Public Methods |
AcceptBinaryFile | Loads a file from the file system and loads it into the database as an internal resource and returns a new URL for the resource. |
ChannelItemIsVisible | Indicates whether the ChannelItem item is visible to the current user. |
CommitAll | Commits changes to all CMS Publishing API objects that have been modified during the most recent session transaction. |
Dispose | Releases all file handles and all unmanaged memory resources held by the CmsContext and objects retrieved directly or indirectly from CmsContext. |
Equals | Determines whether two Object instances are equal. |
GetHashCode | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. |
GetType | Gets the Type of the current instance. |
PropagateParameter | Adds a name/value pair to CMS-generated URLs for the remainder of the session. |
ResolveUrl | Makes URLs that are not generated by CMS compatible with the CMS Site Stager. |
RollbackAll | Rolls back changes made to any CMS Publishing API objects that have been modified in the current session transaction. |
ToString | Returns a String that represents the current object type. |
UserHasRight ToBrowse | Indicates if the user has permissions to browse the current ChannelItem. |
