Web Part Schema

This section describes the Web Part schema and explains how a dashboard view interprets the various property values. The properties listed in this section are part of the Web Part content class that the default dashboard factory engine uses. You can define additional properties for Web Parts, but they will not be part of the base content class.

The following table lists the Web Part schema properties in alphabetical order. The second column in the table indicates whether the property is user- or view-specific. Properties that are not user-specific contain metadata about the Web Part. You can implement a dashboard so that it stores specific property values for each user, enabling different users to set different values for certain properties.

Name

User Specific

Description

AllowMinimize

No

Indicates whether a user can minimize the Web Part.

AllowRemove

No

Indicates whether a user can remove the Web Part from a dashboard.

CacheBehavior

No

Controls whether and how a dashboard factory caches content. Settings are None, All Users, or Each User.

CacheTimeout

No

Specifies how long a dashboard factory keeps cached results.

Content

No

Contains embedded content (the body of the Web Part).

ContentLink

No

Contains a URL pointing to a document that provides content for the Web Part (an alternative to using embedded content).

ContentType

No

Indicates the type of embedded content the Web Part contains (HTML, VBScript, JavaScript, XML, and so on).

CustomizationLink

No

Contains a URL pointing to a page that allows users to customize the operation of the Web Part.

Description

Yes

Contains a description of the Web Part.

DetailLink

No

Contains a URL pointing to a detail page for the Web Part. This will often be a full-page user interface for the Web Part.

FrameState

Yes

Indicates the frame state of a Web Part (normal or minimized).

 


 

Name

User Specific

Description

HasFrame

No

Indicates whether the Web Part appears in a frame with a title and buttons.

Height

Yes

Specifies a fixed height for the Web Part in the dashboard view.

IsIncluded

Yes

Indicates whether the Web Part should be included in the dashboard.

IsVisible

Yes

Indicates whether a Web Part appears in the dashboard view.

LastModified

Yes

Indicates the date and time the Web Part was last modified (in Greenwich mean time).

MasterPartLink

No

Contains a URL pointing to a master version of the Web Part.

Namespace

No

Specifies the namespace for the Web Part.

PartOrder

Yes

Specifies the order of the Web Part relative to other Web Parts in the same zone.

PartStorage

Yes

Stores user customization parameters. This is an open tag.

RequiresIsolation

No

Indicates whether to isolate the Web Part from other Web Parts on the dashboard.

Title

Yes

Contains the title of the Web Part.

Width

Yes

Specifies a fixed width for the Web Part in the dashboard view.

XSL

No

Contains embedded XSL to use on the content of a Web Part before rendering the content on the dashboard.

XSLLink

No

Contains a URL pointing to XSL to use on content of the Web Part before rendering the content on the dashboard.

Zone

Yes

Indicates the dashboard zone in which the Web Part is located. A digital dashboard is divided into five zones.

 

A number of metadata properties such as author, categories, and so on, already exist in Exchange for other item types. You can use these properties on Web Parts too. However, a dashboard factory may ignore the values in these properties.

Web Part Schema Reference

The topics in this section contain detailed information about each property in the Web Part schema.

Under each property description is a table of values. These are the settings that Exchange requires for a property definition. Other data stores use these as a guide to schema settings for the property and will probably ignore most of the attributes.


AllowMinimize

The AllowMinimize property indicates whether users can minimize the Web Part in the dashboard view, reducing it to a title bar or some other title-only, reduced-content appearance. You may want a particular Web Part, such as an advertising banner or primary navigation Web Part, to be visible at all times. If so, set this property to FALSE. If you set this property to TRUE, the user can minimize the Web Part if the dashboard includes a minimize feature. (There is no strict requirement that a dashboard view provide a minimize feature. It is only required that the view does not allow a Web Part to be minimized if this property is set to FALSE.)

If you set this property and the AllowRemove property to FALSE, the Web Part will always be visible in the dashboard view, and users cannot remove or hide the Web Part. Note that this property does not have an effect on the Exchange engine. It is possible for someone using an Exchange client such as CDO to access an individual item and set the IsIncluded property to FALSE—even if you set this property to FALSE. Use engine-level Access Control Lists (ACLs) to prohibit users from modifying these properties using other access paths.

Property Definition

Value

Data Type

Boolean

Default

TRUE

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

N/A

 


AllowRemove

The AllowRemove property controls whether a user can remove the Web Part from the dashboard. If you set this property to FALSE, users cannot remove the Web Part from the main dashboard view or any layout customization page.

Note that this property does not have an effect on the Exchange engine. A user with an Exchange client such as CDO can access the item and set the IsIncluded property to FALSE—even if you set AllowRemove to FALSE. Use engine-level Access Control Lists (ACLs) to prohibit users from modifying these properties using other access paths.

Property Definition

Value

Data Type

Boolean

Default

TRUE

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

N/A

 


CacheBehavior

The CacheBehavior property indicates how a dashboard factory should cache the HTML generated for a given Web Part. Caching this HTML may dramatically improve performance when refreshing, but the Web Part will potentially ignore new data from a content link until the cache timeout has occurred. This property can contain one of the following values.

Value

Meaning

0

No caching.

1

Cache HTML for each user. If the dashboard factory cannot cache HTML for each user, it should not cache HTML at all.

2

Cache HTML for all users. The dashboard factory keeps one cache for all users. You should use this setting only when the content of the Web Part is not user-specific because all users share the same cache.

 

Dashboard factories can handle values other than these; however, a dashboard uses the default setting of 0 (no caching) if it cannot interpret the value. If a dashboard factory cannot cache generated HTML for each user (for example, if there is no ASP application for the current folder), it does not cache the HTML for any Web Part whose CacheBehavior property is set to 1 (cache HTML for each user), because this would violate security and potentially expose personal information to other users. Any page you create to allows users to edit a Web Part should include a warning if a user attempts to set this value to 2, or cache for all users, to explain to the user what that means.

Note that this property will not be supported in the DDRK 2.0 Dashboard Factory. This property may exist, but the Factory will not use it. Future versions of the factory will use this property so Web Part authors may define a value for it now in anticipation of support in a future version.

Property Definition

Value

Data Type

Long

Default

0

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

Plain text


CacheTimeout

The CacheTimeout property specifies, in seconds, how long a dashboard factory keeps and reuses cached HTML before discarding it for new content. The default value of this property is 0, which indicates that the factory should not cache generated HTML. For example, setting this property to 60 and setting CacheBehavior to something other than the default causes a dashboard factory to cache the generated HTML for the Web Part for 60 seconds. After that, the dashboard factory re-generates the HTML for the Web Part and caches it again for another 60 seconds.

Note   A dashboard factory may ignore the cache settings for Web Parts that require isolation. Because the generated HTML is minimal (probably just an IFrame tag) and re-generates quickly, not caching the HTML reduces the overall load on the server.

Note that this property will not be supported in the DDRK 2.0 Dashboard Factory. This property may exist, but the Factory will not use it. Future versions of the factory will use this property so Web Part authors may define a value for it now in anticipation of support in a future version.

 

Property Definition

Value

Data Type

Long

Default

0

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

N/A

 


Content

The Content property represents the body of the Web Part as embedded content. This property is optional. An alternate way of providing content is to link Web Part content using the ContentLink property.

By default, dashboard factories check ContentLink first and use that if specified. If ContentLink has no value, or the factory encounters an error when trying to get the results of the URL, the factory uses the value in the Content property for the current dashboard view.

If you do not need to provide embedded content, you can use this property to store error text that a dashboard displays when the pointer specified in the ContentLink property fails.

Property Definition

Value

Data Type

String

Default

None

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

Plain text

 


ContentLink

The ContentLink property indicates the URL from which the dashboard factory retrieves content for the Web Part. The URL can point to any file or location, including another item on the same store module. Dashboard factories check for a value in the ContentLink property first, using the Content property only when the URL fails to return content.

Property Definition

Value

Data Type

String

Default

None

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

Plain text

 


ContentType

The ContentType property indicates what type of content the Content property contains. The Content property can contain HTML, XML, VBScript, or Java Script. To process content correctly, the dashboard factory must have information about the type of content that Content contains.

The following table lists the possible values for this property. Dashboard factories handle values outside this range as an unknown type, so that you can extend this list for specialized implementations.

Value

Description

0

Content is HTML.

1

Content is VBScript that runs on the server.

2

Content is JavaScript that runs on the server.

3

Content is XML and should be transformed through the XSL or XSLLink property.

 

If you do not define ContentType, dashboard factories treat the contents of the Content property as simple HTML.

Property Definition

Value

Data Type

Long

Default

0

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

N/A

 

Note that if the Content property contains VBScript or JavaScript, the dashboard factory must be able to allow the script to generate content back to the factory. To enable this, make sure you include a function in the script called getContent with the following signature:


JavaScript

function getContent(xmlndPart)

{

    var sContent = new String();

    //code to generate content into sContent

    return sContent;

}

VBScript

Function getContent(xmlndPart)

    Dim sContent

     'code to generate content into sContent

     getContent = sContent

End Function

 

The single input parameter is an MSXML.IXMLDomNode object that contains the property information for the Web Part property information in Web Part XML format. This allows the script content to access properties such as PartStorage to determine any initialization settings that are present. Script can also access the standard ASP Session, Application, Request, and Response objects to get cookies, post and query string parameters, or get any stored session or application state information.

When processing Web Parts with VBScript or JavaScript content, the dashboard factory adds the script necessary to call the getContent function and receive generated content. This is typically done by inserting a line at the beginning of the script such as the following:

g_sContentBuffer = getContent(xmlndCurPart);

where g_sContentBuffer is a global variable in the factory's scope that is used to received the generated content.

Web Parts can also define an Initialize function. The dashboard factory attempts to call this function on all Web Parts that contain scripts before it calls the getContent function for each script. This allows Web Parts to begin parallel asynchronous operations before the dashboard factory requests content. The Initialize function has the same signature as the getContent function, which is one parameter containing the properties of the Web Part.


CustomizationLink

The CustomizationLink property contains a URL for a page that allows users to customize the content of the Web Part; for example, if you are creating a Web Part that lists a number of stocks, you can offer users a way to specify which stock symbols the Web Part displays. You can do this inline in the content of the Web Part, or you can supply a URL in this property and the dashboard view provides a way for the end user to navigate to it. For example, the dashboard view might place a small Edit button on the right side of the Web Part's title bar. When the user clicks the button, the view navigates to this URL, allowing the user to customize the content of the Web Part. Note that this is likely a per-user customization of content and does not affect the properties of the Web Part item in Exchange. In your customization pages, you may want to provide a Submit button that applies the user’s changes and takes the user back to the dashboard view. You can offer this by using JavaScript or VBScript to back up one page (window.history.back method).

This URL can point to anywhere but it typically points to the site that is supplying the content for the Web Part; however, it may also point to another Web Part or even the same Web Part, passing a parameter that indicates customization.

Property Definition

Value

Data Type

String (URL)

Default

None

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

Plain text

 


Description

The Description property contains a description of the Web Part. The value of this property should explain what the Web Part does. This property is often displayed in search results or in a Web Part catalog view. Dashboards may display this in the layout adjustment form.

Property Definition

Value

Data Type

String

Default

None

IsContentIndexed

TRUE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

Plain text

 

DetailLink

The DetailLink property contains a URL that appears in the Web Part frame or heading. This property allows users to view a full-page, detailed interface for the Web Part; for example, you could set this property for a Web Part that exposes top news headlines to provide a way for users to jump to that site's home page.

Dashboard views use this URL as the source for an anchor tag that is wrapped around the title of a Web Part. The user clicks the Web Part title to jump to the site that the URL specifies.

Property Definition

Value

Data Type

String (URL)

Default

None

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

Plain text

 


FrameState

The FrameState property indicates the current frame state of the Web Part. The value for FrameState can be one of the following:

Value

Description

0

The Web Part is displayed maximized.

1

The Web Part is displayed minimized.

 

Dashboard factories use this property value to determine how to render the Web Part initially. If a user minimizes a Web Part, the dashboard view updates this value so that future renderings use the new setting. This list may grow in the future to accommodate other settings such as Maximized. Dashboard factories can handle values other than those listed here and use the default value (0) if the dashboard factory cannot interpret the current value.

Property Definition

Value

Data Type

Long

Default

0

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

N/A

 


HasFrame

The HasFrame property specifies whether the dashboard view displays the Web Part in a visible frame. If you set this property to TRUE, a frame appears around the Web Part in the dashboard view. The frame includes the title bar and any standard buttons that appear in the title bar.

Property Definition

Value

Data Type

Boolean

Default

TRUE

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

N/A

 


Height

The Height property restricts the height of a Web Part in the dashboard view. If you do not set this property, or if you set the property to an empty value, the Web Part will expand in the dashboard view to display all of its content. You can use this property with Web Parts that require isolation and Web Parts that do not (you can use DIV tags to restrict the height and width of content and provide scrolling when the content is larger than the DIV).

Because Height contains a string value, you can use any height measurement allowable in HTML or CSS; for example, you can set this property to 50 to get 50 pixels, or you can set the property to 50% to get 50% of the parent size. CSS also allow measurements such as inches and millimeters.

Property Definition

Value

Data Type

String

Default

None

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

Plain text

 


IsIncluded

The IsIncluded property indicates whether the Web Part is included in the dashboard view. If you (or the user) set this property to FALSE, the dashboard factory does not render the Web Part in the dashboard view.

Property Definition

Value

Data Type

Boolean

Default

TRUE

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

N/A

 


IsVisible

The IsVisible property indicates whether a Web Part is visible in the dashboard view, or whether it is present but invisible. You may want to create a helper Web Part that is not visible but supplies a central service to other Web Parts on the page. A dashboard factory includes Web Parts with IsVisible set to FALSE but they take up no space in the view layout.

Property Definition

Value

Data Type

Boolean

Default

TRUE

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

N/A

 


LastModified

The LastModified property contains the date and time this item was last modified in Greenwich Mean Time (GMT). Dashboard factories may use this value to compare a master Web Part or Web Part folder to a copy to determine whether the copy should be updated.

Property Definition

Value

Data Type

DateTime

Default

creation date/time

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

N/A

 


MasterPartLink

When defined, the MasterPartLink property contains a URL pointing to the master version of the Web Part, or it can contain the primary key value of the master Web Part if the data store does not use HTTP references. If this property contains a value, the dashboard factory follows this URL to obtain the master version of the Web Part and uses the non-user-specific properties of that instance. If the master Web Part has been modified more recently than the current instance, the dashboard factory updates the non-user-specific properties of the current instance to match those of the master Web Part. See the table at the beginning of this document for information about which Web Parts are user-specific. If the dashboard factory cannot access the master Web Part (if the Web Part is offline or if the server is unavailable), the dashboard factory uses the property values of the current instance and continues processing the Web Part. The current instance functions as a cache of the master Web Part for offline and disconnected use.

Note that when a user copies a Web Part from one folder to another, this property retains its value and is not reset to the source of the copy. This ensures that the master Web Part is only one link away; all copies of a particular Web Part point to the same master Web Part unless you explicitly change the value for this property. If you edit this property to create a multi-link chain to the master Web Part, the dashboard factory follows those links.

For more information, see the AutoUpdate property in the Dashboard Schema document.

Property Definition

Value

Data Type

String (URL)

Default

None

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

Plain text

 


Namespace

The Namespace property contains a namespace for the Web Part, which provides the dashboard factory with a name qualifier that it can use for a number of different operations.

Property Definition

Value

Data Type

String

Default

None

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

Plain text

 


PartOrder

The PartOrder property indicates the order of the Web Part relative to other Web Parts in the same zone. If more than one Web Part contains the same value in PartOrder, those Web Parts will appear on the dashboard in random order, but they will appear after Web Parts with a lower number and before Web Parts with a higher number. For example, if the PartOrder properties of six Web Parts in zone 5 contain the values 1, 2, 3, 3, 3, and 4, the Web Parts with a value of 3 appear after the Web Part with the value 2 and before the Web Part with a value of 4, but the Web Parts with a value of 3 appear in the dashboard view in an unpredictable order. For information about zones, see “Zone” later in this document.

Property Definition

Value

Data Type

Long

Default

0

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

N/A

 


PartStorage

The PartStorage property stores user-specific customization information. This property is similar to a Tag property in Microsoft Visual Basic. This property is a string property so Web Parts will typically invent an XML format to fit many pieces of information into one string.

Property Definition

Value

Data Type

String

Default

None

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

Plain text

 


RequiresIsolation

The RequiresIsolation property places the Web Part in an IFrame, which isolates the Web Part from the rest of the Web Parts on the dashboard. To isolate a Web Part, set this property to TRUE. Isolation provides the following benefits:

·         Script functions and event sinks run as though they are the only scripts on the page. Function names and event sinks do not conflict with those of other Web Parts on the dashboard.

·         HTML IDs do not conflict with those of other Web Parts. Any ID referenced in the script of an isolated Web Part uniquely identifies an element in the content of that Web Part.

IFrames provide a few additional characteristics you may find useful:

·         Requests for content originate from the client computer, so you can use cookies and basic authentication prompting.

·         The request for content occurs asynchronously from the rest of the page. This can be useful for Web Parts with content links that return slowly.

Note that Netscape Navigator does not support IFrames, nor any other suitable mechanism for isolation. Therefore isolated parts will not render in Netscape Navigator.

Property Definition

Value

Data Type

Boolean

Default

FALSE

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

N/At

 


Title

The Title property contains the title of the Web Part. It is a required property. This property should contain a text string because the dashboard will display this property as a title above the Web Part content. The standard Exchange/DAV property definition is used for this property when using a Web store. Its full name is urn:schemas:mailheader:subject. For non-Exchange stores, the property can simply be called "Title".

Property Definition

Value

Data Type

String

Default

None

IsContentIndexed

TRUE

IsIndexed

TRUE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

TRUE

IsVisible

TRUE

Version

1

TextFormat

Plain text

 


Width

The Width property restricts the width of a Web Part in the dashboard view. If you do not set this property or if you set the property to an empty value, the Web Part will expand in the dashboard to display all of its content. You can use this property with Web Parts that require isolation and Web Parts that do not (you can use DIV tags to restrict the height and width of content and provide scrolling when the content is larger than the DIV).

Because this property contains a string value, you can use any width measurement allowable in HTML or CSS; for example, you can set this property to 50 to get 50 pixels, or you can set the property to 50% to get 50% of the parent size. CSS also allow measurements such as inches and millimeters.

Property Definition

Value

Data Type

String

Default

None

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

Plain text

 


XSL

When defined, the XSL property contains an XSL string that the dashboard factory uses to transform the XML content of a Web Part before rendering it in the dashboard view. This property and the XSLLink property are similar to the Content and ContentLink properties. Dashboard factories first check the XSLLink property for a value. If XSLLink is defined, the dashboard factory retrieves content from that link and ignores the XSL property. If XSLLink is not defined or is inaccessible, the dashboard factory then uses the contents of XSL. If neither property is defined or if XSLLink fails and XSL does not contain a value, the dashboard factory will not transform the content of the Web Part and will display it in the dashboard view as is.

Property Definition

Value

Data Type

String (XSL)

Default

None

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

Plain text

 


XSLLink

When defined, the XSLLink property contains a URL pointing to an XSL string that a dashboard factory uses to transform the XML content of a Web Part before rendering that content in the dashboard view. For details on how to use the XSLLink property in conjunction with the XSL property, see “XSL.”

Property Definition

Value

Data Type

String (URL)

Default

None

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

Plain text

 


Zone

The Zone property specifies the zone in which the Web Part appears on the dashboard. Each zone has a corresponding number, which the following table describes.

Value in Schema

Description

0

Body of the dashboard, which may physically be anywhere.

1

Left side of the dashboard.

2

Right side of the dashboard.

3

Center of the dashboard.

4

Header section of the dashboard.

5

Footer section of the dashboard.

 

This value indicates the location in which the designer wants the Web Part to be placed. The dashboard factory may adjust the actual placement of the Web Part based on other preferences the user defines. For example, the default value of Body means that the Web Part designer wants the Web Part to appear in the main body area of the current layout. User settings for a dashboard layout may cause the main section to appear in different places. Similarly, there may be many sections that are considered the main body, which means that the dashboard factory must resolve the exact placement of the Web Part on the dashboard.

Left, Right, and Center settings indicate regions on the screen. Typically, the left and right side of any given layout is fixed in size, while the center section (or sections) are dynamic in size, using all available room. If the dashboard layout does not provide the section specified in Zone, the dashboard factory places the Web Part in another section that has similar layout characteristics. For example, in a two-column layout that has a left zone of fixed size and a center zone of variable size, the dashboard factory would place a Web Part whose Zone property is set to Right in the fixed left zone, because both left and right zones have a fixed width.

Header and Footer settings specify a top or bottom location for the Web Part. If a layout does not have a specific header or footer section, the dashboard factory will place the Web Part in an alternate location that has similar characteristics. For example, if the layout does not include a header section, the dashboard factory will place a Web Part whose Zone property is set to Header before other Web Parts in the main body or center section.


 

Property Definition

Value

Data Type

Long

Default

0

IsContentIndexed

FALSE

IsIndexed

FALSE

IsMultiValued

FALSE

IsReadOnly

FALSE

IsRequired

FALSE

IsVisible

TRUE

Version

1

TextFormat

N/A

 


Schema Priorities and Conflicts

In some cases, setting a property to a certain value causes dashboard factories to ignore values in other properties. The following table contains a list of property settings for which this is true.

Property Setting

Result

AutoUpdate = 0 (never update)

 

MasterPartLink properties on the folder and Web Parts are ignored. No master Web Part processing is performed.

RequiresIsolation = TRUE

 

Most dashboards will ignore the XSL or XSLLink properties. Dashboards may allow Content with no ContentLink, but this may not be supported. In general, if you set RequiresIsolation to TRUE, the Web Part should have a ContentLink value.

IsVisible = FALSE

 

If a Web Part is invisible, the values for properties that control appearance are meaningless; for example, HasFrame, FrameState, CustomizationLink, and AllowRemove are ignored.

IsIncluded = FALSE

 

If a Web Part is not included, the dashboard factory ignores most Web Part properties when rendering the view. When building a view, the dashboard factory generally does not process Web Parts that have this property set to false.