Common Web Part properties

All Web Parts share a common set of properties that control their appearance, layout, and advanced characteristics. The common Web Part properties are listed below with their corresponding base class property name in parentheses.

This topic describes all the common Web Part properties. However, the common Web Part properties you see in the tool pane may be different than what is documented in this topic for several reasons:

To see the Advanced section in the tool pane, you must have appropriate permission.
For a specific Web Part, a Web Part developer may have chosen not to display one or more of these common properties, or may have chosen to create and display additional properties not listed below in the Appearance, Layout, and Advanced sections of the tool pane.
Some permissions and property settings may disable or hide Web Part properties.

Title (Title)

Specifies the title of the Web Part displayed in the Web Part title bar.

Type a string in the text box. To make it easier to edit a long string, click Text Builder Button image .

Height (Height)

Specifies the height of the Web Part.

Do one of the following:

To specify a fixed height, select Yes, type a positive number in the text box, and then select a unit of measurement. The following are valid units of measurement: Centimeters, Inches, Millimeters, Points, Picas, and Pixels (the default).
To automatically adjust the height of the Web Part in the zone, select No. This is the default.

Width (Width)

Specifies the width of the Web Part.

Do one of the following:

To specify a fixed width, select Yes, type a positive number in the text box, and then select a unit of measurement. The following are valid units of measurement: Centimeters, Inches, Millimeters, Points, Picas, and Pixels (the default).

To automatically adjust the width of the Web Part in the zone, select No. This is the default.

Frame State (FrameState)

Specifies the initial state of the Web Part frame.

Do one of the following:

To display only the Web Part title bar, select Minimized.
To display the entire Web Part, select Normal. This is the default.

Frame Style (FrameType)

Specifies the style of the Web Part frame.

Do one of the following:

To use the value of the FrameType Web Part zone property specified, select Default. This is the default.
To display the content, but not the title bar and frame, select None.
To display the title bar, content, and frame, select Title Bar and Border.
To display the title bar and content, but no frame, select Title Bar Only.

Visible on Page (IsVisible)

Specifies whether the Web Part is displayed or hidden when browsing the Web Part Page. The Web Part is still visible when you are designing the page and has the suffix (hidden) appended to the title.

You might make a Web Part hidden if you want to use it to provide data to another Web Part through a Web Part connection, but don't need to display the Web Part.

Do one of the following:

To display the Web Part, select the check box. This is the default.
To hide the Web Part, clear the check box.

Direction (Dir)

Specifies the direction of the text in the Web Part content. For example, Arabic and Hebrew are right-to-left languages; English and most other European languages are left-to-right languages.

Do one of the following:

To automatically choose a text direction based on the language setting of the site or subsite the Web Part Page is located in, select Default. This is the default.
To set the text direction to read left to right, select Left to Right.
To set the text direction to read right to left, select Right to Left.

Zone (ZoneID)

Specifies the zone on the Web Part Page where the Web Part is located.

To choose a zone, select a zone name from the list.

Note Zones on the Web Part Page are not listed in the list box when you do not have permission to modify the zone.

Part Order (PartOrder)

Specifies the position of the Web Part in a zone when the zone contains more than one Web Part.

To specify the order, type a positive integer in the text box.

A value of 1 means the Web Part is placed at the top of the zone, if the Web Parts in the zone stack from top to bottom, or to the left of the zone, if the Web Parts in the zone stack from left to right.

For example, when you add a Web Part to an empty zone that stacks from top to bottom, the Part Order is 1. When you add a second Web Part to the bottom of the zone, its Part Order is 2. To move the second Web Part to the top of the zone, type 1, and then type 2 for the first Web Part .

Note Each Web Part in the zone must have a unique Part Order number. Therefore, changing the Part Order value for the current Web Part can also change the Part Order value for other Web Parts in the zone.

Allow Minimize (AllowMinimize)

Specifies whether or not the Web Part can be minimized.

Do one of the following:

To allow a Web Part to be minimized, select the check box. This is the default.
To prevent a Web Part from being minimized, clear the check box.

Allow Close (AllowRemove)

Specifies whether or not the Web Part can be removed from the Web Part Page.

Do one of the following:

To allow a Web Part to be closed, select the check box. This is the default.
To prevent a Web Part from being closed, clear the check box.

Allow Zone Change (AllowZoneChange)

Specifies whether or not the Web Part can be moved to a different zone.

Do one of the following:

To allow a Web Part to be moved to a different zone, select the check box. This is the default.
To prevent a Web Part from being moved to a different zone, clear the check box.

Allow Export Sensitive Properties (ExportSensitiveProperties)

Controls whether a user can export to a Web Part description file (.dwp) the values of one or more specific properties when making changes to a Web Part Page in personal view. This property also controls whether a Web Part property can be accessed by the Web Part Services Component (WPSC) that runs on the client computer or used in the default web service.

The ExportControlledProperties property is useful for preventing the viewing and distribution of one or more property values that may contain sensitive information, such as a social security number, a credit card number, or a connection string.

To enable the ExportControlledProperties property, the developer of the Web Part must mark the specific Web Part properties with the ControlledExport attribute by setting the attribute value to True.

After the Web Part is installed at a site and uploaded to a Web Part gallery, the ExportControlledProperties property of the Web Part is False by default, which means one or more of the Web Part's properties marked as sensitive by the ControlledExport attribute cannot be exported in personal view, accessed through the WPSC, and used in the default web service. However, a site administrator or user with permission can still set the ExportControlledProperties property to True, if desired or necessary. For more information about how to use this property, see the Windows SharePoint Services Software Development Kit.

Do one of the following:

To prevent a user from exporting values of the specified properties in personal view, access by the Web Part Services Component (WPSC) that runs on the client computer, or used in the default web service, clear the check box (The sets the property value to False). This is the default.
To allow a user to export values of the specified properties in personal view, access by the Web Part Services Component (WPSC) that runs on the client computer, or used in the default web service, select the check box (This sets the property value to True).

Detail Link (DetailLink)

Specifies the URL of a file containing additional information about the Web Part. The file is displayed in a separate browser window when you click the Web Part title.

Type a file path or hyperlink in the text box. To make it easier to edit a long string, click Text Builder Button image .

Description (Description)

Specifies the ScreenTip that appears when you rest the mouse pointer on the Web Part title or Web Part icon. When you search for Web Parts by using the Search command on the Find Web Parts menu of the tool pane, the value of this property is used when searching the following Web Part galleries: Site, Virtual Server, and Web Part Page.

Type a string in the text box. To make it easier to edit a long string, click Text Builder Button image .

Help Link (HelpLink)

Specifies the location of a file containing help information about the Web Part. The help information is displayed in a separate browser window when you click the Help command on the Web Part menu.

Type a file path or hyperlink in the text box. To make it easier to edit a long string, click Text Builder Button image .

Icon File (Large) (PartImageLarge)

Specifies the location of a file containing a large Web Part icon. The image size must be 16 by 16 pixels.

Type a file path or hyperlink in the text box. To make it easier to edit a long string, click Text Builder Button image .

Icon File (Small) (PartImageSmall)

Caution This property is reserved for future use by Microsoft, and the value is not saved if you enter it in the tool pane.

Missing Assembly Error (MissingAssembly)

Specifies a message that appears if the Web Part assembly file is missing or incorrect.

Type a string in the text box. To make it easier to edit a long string, click Text Builder Button image .

Is Included Filter (IsIncludedFilter)

Note The name of this property in the tool pane can be customized by a site administrator or Web Part developer and may be different than the name "Is Included Filter."

Specifies a query string with criteria defined by a developer or site administrator to determine whether or not to display the Web Part. This property is used by developers who want to customize Microsoft Windows SharePoint Services to target the display of Web Parts for certain groups of people. This property is not displayed in the tool pane if it is not used, and it is always the last property displayed in the Advanced section of the tool pane. For more information about how to use this property, see the Windows SharePoint Services Software Development Kit

Type a string in the text box. To make it easier to edit a long string, click Text Builder Button image .