Channel Parentage

Table B-5 shows the complete parentage of a CMS Channel 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 GetHashCode is coded in the CmsObject class, whereas Equals, GetType, and ToString are coded in the System. Object class and then inherited by the CmsObject class. All these members are inherited by the HierarchyItem class, the ChannelItem class, and finally the Channel class. AllChildren, for example, is coded in the Channel class and is not inherited by any other class.

Table B-5. Channel Parentage

Channel

Channel Item

Hierarchy Item

Cms Object

System. Object

Public Properties

AllChildren

ApplyOuter ScriptToPostings

    

CanCreateChannels

    

CanCreatePostings

    

CanDelete

CanDelete

CanDelete

  

CanSet Properties

CanSet Properties

CanSet Properties

  

ChangeDate

ChangeDate

   

Channels

    

CreatedBy

CreatedBy

CreatedBy

  

CreatedDate

CreatedDate

CreatedDate

  

Custom Properties

Custom Properties

   

DefaultPostingName

    

DefaultResource Gallery

    

DefaultTemplate Gallery

    

Description

Description

Description

  

DisplayName

DisplayName

   

DisplayPath

DisplayPath

   

ExpiryDate

ExpiryDate

   

Guid

Guid

Guid

  

IsDeleted

IsDeleted

IsDeleted

  

IsHidden Mode Published

IsHidden Mode Published

   

IsImportant

IsImportant

   

IsRobot Followable

IsRobot Followable

   

IsRobot Indexable

IsRobot Indexable

   

IsRoot

    

IsWorkingRevision

IsWorking Revision

IsWorking Revision

  

LastModifiedBy

Last ModifiedBy

Last ModifiedBy

  

LastModifiedDate

LastModified Date

LastModified Date

  

Name

Name

Name

  

OuterScriptFile

    

OwnedBy

OwnedBy

OwnedBy

  

Parent

Parent

   

Path

Path

Path

  

Postings

    

QueryString

QueryString

   

QueryString Mode Unpublished

QueryString Mode Unpublished

   

QueryString ModeUpdate

QueryString ModeUpdate

   

RevisionDate

RevisionDate

RevisionDate

  

SortOrdinal

SortOrdinal

   

StartDate

StartDate

   

Url

Url

   

UrlInner

UrlInner

   

UrlInnerPlain

UrlInnerPlain

   

UrlModePublished

UrlModePublished

   

UrlModeUnpublished

UrlModeUnpublished

   

UrlModeUpdate

UrlModeUpdate

   

Public Methods

CreateChannel

    

CreateConnected

    

Posting

    

CreatePosting

    

Delete

Delete

Delete

  

Equals

Equals

Equals

Equals

Equals

GetByRelativePath

GetBy RelativePath

   

GetHashCode

GetHash Code

GetHash Code

GetHash Code

 

GetType

GetType

GetType

GetType

GetType

IsDescendantOf

IsDescendant Of

IsDescendant Of

  

ToString

ToString

ToString

ToString

ToString

Channels inherit much of their functionality from ChannelItem and HierarchyItem.

Table B-6 defines all the members listed for the Channel class in Table B-5.

Table B-6. Channel Member Descriptions

Channel

Classification

Description

Public Properties

AllChildren

Child object

Gets all the Channels and Postings within this Channel.

ApplyOuter ScriptTo Postings

Read/write

Gets or sets a value indicating whether the outer script should be executed for Posting objects.

CanCreate Channels

User right

Gets a value indicating whether the user has the necessary rights to create new Channel objects within this Channel.

CanCreate Postings

User right

Gets a value indicating whether the user has the necessary rights to create new Postings within this Channel.

CanDelete

User right

Gets a value indicating whether the current user has sufficient rights to delete this class instance.

CanSet Properties

User right

Gets a value indicating whether the current user has sufficient rights to modify the properties of this class instance.

ChangeDate

Read-only

Gets the Coordinated Universal Time (UTC) when ChannelItem was last changed.

Channels

Child object

Gets the Channel objects within this Channel.

CreatedBy

Read-only

Gets the User that created this class instance.

CreatedDate

Read-only

Gets the UTC when the HierarchyItem was created.

Custom Properties

Child object

Gets the CustomPropertyCollection for this ChannelItem object.

Default PostingName

Read/write

Gets or sets the name of the default Posting for this Channel.

Default Resource Gallery

Read/write

Gets or sets the default ResourceGallery for this Channel.

Default Template Gallery

Read/write

Gets or sets the default Template Gallery for this Channel.

Description

Read/write

Gets or sets descriptive text for this class instance.

DisplayName

Read-only

Gets and sets the display name for this Channel Item object.

DisplayPath

Read-only

Gets the fully qualified path of a ChannelItem.

ExpiryDate

Read/write

Gets and sets the UTC at which this Channel Item expires and ceases to be a visible part of the published Web site.

Guid

Read-only

Gets a string representation of the globally unique identifier (GUID) for this object.

IsDeleted

Read-only

Gets a value indicating whether this class instance has been deleted, regardless of whether the deletion has been committed.

IsHidden Mode Published

Read/write

Gets and sets a flag indicating whether this ChannelItem is hidden in the navigation hier archy of the live (published) CMS Web site.

IsImportant

Read/write

Gets or sets a value indicating whether a ChannelItem is important.

IsRobot Followable

Read/write

Gets and sets a value indicating whether Web robots should follow any hyperlinks found in the Web page corresponding to this ChannelItem object.

IsRobot Indexable

Read/write

Gets and sets a value indicating whether Web robots should index the Web page corresponding to this ChannelItem object.

IsRoot

Read-only

Gets a value indicating whether this Channel is the root Channel in the channel hierarchy.

IsWorking Revision

Read-only

Gets a value indicating whether the Hierarchy Item is a working revision.

Last ModifiedBy

Read-only

Gets the User that last modified the Hierarchy Item.

Last ModifiedDate

Read-only

Gets the UTC when this HierarchyItem was last modified.

Name

Read/write

Gets or sets the name of this HierarchyItem.

OuterScript

Read/write

Gets or sets the outer script file for this Channel.

FileOwnedBy

Read-only

Gets the User who currently owns the class instance.

Parent

Child object

Gets the Channel that contains this Channel Item object.

Path

Read-only

Gets the fully qualified path of the Hierarchy Item.

Postings

Child object

Gets the Postings within this Channel.

QueryString

Read-only

Gets the URL QueryString parameters for this ChannelItem.

QueryString Mode Unpublished

Read-only

Gets the URL QueryString parameters used to view this ChannelItem when in Unpublished mode.

QueryString ModeUpdate

Read-only

Gets the URL QueryString parameters used by this ChannelItem when in Update mode.

RevisionDate

Read-only

Gets a System.DateTime that gets the UTC when this historical revision of this Hierarchy Item was created.

SortOrdinal

Read/write

Gets and sets the relative position of this ChannelItem with respect to its sibling Channel Item objects.

StartDate

Read/write

Gets and sets the UTC at which this Channel Item becomes visible in the published Web site.

Url

Read-only

Gets the URL for this ChannelItem object.

UrlInner

Read-only

Gets a URL that references the ChannelItem, bypassing the outer script file.

UrlInnerPlain

Read-only

Gets a URL that references the ChannelItem, bypassing the outer script file and not propagating any QueryString parameters from the current request.

UrlMode Published

Read-only

Gets the URL for this ChannelItem in Published mode.

UrlMode Unpublished

Read-only

Gets the URL for this ChannelItem in Unpublished mode.

UrlMode Update

Read-only

Gets the URL for this ChannelItem in Update mode.

Public Methods

Create Channel

Creating and deleting

Creates a new Channel within the current Channel.

Create Connected Posting

Creating and deleting

Creates a new Posting in this Channel that is connected to the specified Posting.

Create Posting

Creating and deleting

Creates a new Posting in this Channel.

Delete

Creating and deleting

Deletes the HierarchyItem.

Equals

System

Determines whether two Object instances are equal.

GetBy RelativePath

Child object

Locates a ChannelItem in the channel hierarchy according to its position relative to this Channel Item.

GetHash Code

Read-only

Gets the hash code for the object.

GetType

Read-only

Gets the Type of the current instance.

IsDescendant Of

Read-only

Determines whether this object is a descendant of the specified object.

ToString

System

Returns a String that represents the current object type.

We have included a classification column in Table B-6. This is not a CMS classification. It was included to make it easier to locate the discussion about each member in Chapter 25.



Microsoft Content Management Server 2002. A Complete Guide
Microsoft Content Management Server 2002: A Complete Guide
ISBN: 0321194446
EAN: 2147483647
Year: 2003
Pages: 298

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net