ToolPane members

Represents the tool pane on a Web Part Page. This class cannot be inherited.

The ToolPane type exposes the following members.

Constructors

  Name Description
Public method ToolPane Initializes a new instance of the ToolPane class.

Top

Properties

  Name Description
Public property AccessKey (Inherited from WebControl.)
Protected property Adapter (Inherited from Control.)
Public property Apply Gets a System.Web.UI.WebControls.Button object that represents the Apply button of the tool pane.
Public property ApplyVerb (Inherited from EditorZoneBase.)
Public property AppRelativeTemplateSourceDirectory (Inherited from Control.)
Public property AssociatedDisplayModes (Inherited from ToolZone.)
Public property Attributes (Inherited from WebControl.)
Public property BackColor (Inherited from WebControl.)
Public property BackImageUrl (Inherited from WebZone.)
Public property BindingContainer (Inherited from Control.)
Public property BorderColor (Inherited from WebControl.)
Public property BorderStyle (Inherited from WebControl.)
Public property BorderWidth (Inherited from WebControl.)
Public property Cancel Gets a System.Web.UI.WebControls.Button object that represents the Cancel button of the tool pane.
Public property CancelVerb (Inherited from EditorZoneBase.)
Protected property ChildControlsCreated (Inherited from Control.)
Public property ClientID (Inherited from Control.)
Public property ClientIDMode (Inherited from Control.)
Protected property ClientIDSeparator (Inherited from Control.)
Public property CommandUI Gets a System.Web.UI.WebControls.PlaceHolder object that represents the command area of the tool pane.
Protected property Context (Inherited from Control.)
Public property Controls (Inherited from CompositeControl.)
Public property ControlStyle (Inherited from WebControl.)
Public property ControlStyleCreated (Inherited from WebControl.)
Public property CssClass (Inherited from WebControl.)
Public property DataItemContainer (Inherited from Control.)
Public property DataKeysContainer (Inherited from Control.)
Protected property DesignMode (Inherited from Control.)
Protected property Display (Overrides EditorZoneBase.Display.)
Public property EditorPartChrome (Inherited from EditorZoneBase.)
Public property EditorParts (Inherited from EditorZoneBase.)
Public property EditUIStyle (Inherited from ToolZone.)
Public property EmptyZoneText (Inherited from EditorZoneBase.)
Public property EmptyZoneTextStyle (Inherited from WebZone.)
Public property Enabled (Inherited from WebControl.)
Public property EnableTheming (Inherited from WebControl.)
Public property EnableViewState (Inherited from Control.)
Public property EncodeErrorText
Public property ErrorStyle (Inherited from WebZone.)
Public property ErrorText Gets or sets the text to display in the tool pane when an error occurs. (Overrides EditorZoneBase.ErrorText.)
Protected property Events (Inherited from Control.)
Public property FixedAreas Gets a list of the areas of the tool pane that can contain links or controls.
Public property Font (Inherited from WebControl.)
Public property FooterStyle (Inherited from WebZone.)
Public property ForeColor (Inherited from WebControl.)
Public property HasAttributes (Inherited from WebControl.)
Protected property HasChildViewState (Inherited from Control.)
Protected property HasFooter (Inherited from WebZone.)
Protected property HasHeader (Inherited from WebZone.)
Public property HeaderCloseVerb (Inherited from ToolZone.)
Public property HeaderStyle (Inherited from WebZone.)
Public property HeaderText (Inherited from EditorZoneBase.)
Public property HeaderVerbStyle (Inherited from ToolZone.)
Public property Height (Inherited from WebControl.)
Public property ID (Inherited from Control.)
Protected property IdSeparator (Inherited from Control.)
Public property InCustomToolPane Gets a value indicating whether the tool pane is hosted in the toolpane.aspx page within a Windows SharePoint Services-compatible HTML editor, such as Microsoft Office SharePoint Designer 2007 or another client application.
Public property InstructionText (Inherited from EditorZoneBase.)
Public property InstructionTextStyle (Inherited from ToolZone.)
Protected property IsChildControlStateCleared (Inherited from Control.)
Protected property IsEnabled (Inherited from WebControl.)
Protected property IsTrackingViewState (Inherited from Control.)
Protected property IsViewStateEnabled (Inherited from Control.)
Public property LabelStyle (Inherited from ToolZone.)
Protected property LoadViewStateByID (Inherited from Control.)
Public property NamingContainer (Inherited from Control.)
Public property NeedLayoutCanvas Gets or sets a value indicating whether the layout canvas of the Web Part Page is displayed.
Public property NotifyUI Gets a System.Web.UI.WebControls.PlaceHolder that you can use to insert controls in the notification area of the tool pane.
Public property OK Gets a System.Web.UI.WebControls.Button object that represents the OK button on the tool pane.
Public property OKVerb (Inherited from EditorZoneBase.)
Public property Padding (Inherited from WebZone.)
Public property Page (Inherited from Control.)
Public property Parent (Inherited from Control.)
Public property PartChromePadding (Inherited from WebZone.)
Public property PartChromeStyle (Inherited from WebZone.)
Public property PartChromeType (Inherited from WebZone.)
Public property PartStyle (Inherited from WebZone.)
Public property PartTitleStyle (Inherited from WebZone.)
Protected property RenderClientScript (Inherited from WebZone.)
Public property RenderingCompatibility (Inherited from Control.)
Public property SelectedWebPart Gets the currently selected WebPart.
Public property SelectedZone Gets the selected zone on a Web Part page.
Public property Site (Inherited from Control.)
Public property SkinID (Inherited from WebControl.)
Public property Style (Inherited from WebControl.)
Public property SupportsDisabledAttribute (Inherited from CompositeControl.)
Public property TabIndex (Inherited from WebControl.)
Protected property TagKey (Inherited from WebZone.)
Protected property TagName (Inherited from WebControl.)
Public property TemplateControl (Inherited from Control.)
Public property TemplateSourceDirectory (Inherited from Control.)
Public property ToolParts Gets an array of the Microsoft.SharePoint.WebPartPages.ToolPart objects in the tool pane.
Public property ToolTip (Inherited from WebControl.)
Public property UniqueID (Inherited from Control.)
Public property VerbButtonType (Inherited from WebZone.)
Public property VerbStyle (Inherited from WebZone.)
Public property View Gets or sets the current view of the tool pane.
Protected property ViewState (Inherited from Control.)
Protected property ViewStateIgnoresCase (Inherited from Control.)
Public property ViewStateMode (Inherited from Control.)
Public property Visible (Inherited from ToolZone.)
Protected property WebPartManager (Inherited from WebZone.)
Protected property WebPartToEdit (Inherited from EditorZoneBase.)
Public property Width Gets or sets the minimum width of the tool pane. (Overrides WebControl.Width.)

Top

Methods

  Name Description
Protected method AddAttributesToRender (Inherited from WebControl.)
Protected method AddedControl (Inherited from Control.)
Protected method AddParsedSubObject (Inherited from Control.)
Public method ApplyStyle (Inherited from WebControl.)
Public method ApplyStyleSheetSkin (Inherited from Control.)
Protected method BuildProfileTree (Inherited from Control.)
Protected method ClearCachedClientID (Inherited from Control.)
Protected method ClearChildControlState (Inherited from Control.)
Protected method ClearChildState (Inherited from Control.)
Protected method ClearChildViewState (Inherited from Control.)
Protected method ClearEffectiveClientIDMode (Inherited from Control.)
Protected method Close (Inherited from EditorZoneBase.)
Public method CopyBaseAttributes (Inherited from WebControl.)
Protected method CreateChildControls Called by ASP.NET during Child Control creation. Setup the child controls and current view to add to the toolpane. (Overrides EditorZoneBase.CreateChildControls().)
Protected method CreateControlCollection (Inherited from Control.)
Protected method CreateControlStyle (Inherited from WebControl.)
Protected method CreateEditorPartChrome Called to create an EditorPartChrome which can be used to create the SPEditorPartChrome which will be used to render ToolParts and EditorParts (Overrides EditorZoneBase.CreateEditorPartChrome().)
Protected method CreateEditorParts Called to create Editor Parts (includes ToolParts) which will be appended to EditorParts. (Overrides EditorZoneBase.CreateEditorParts().)
Public methodStatic member CreateZoneDropdown(SPWebPartManager) Creates the dropdown with the list of zones
Public methodStatic member CreateZoneDropdown(WebPartPage) Obsolete. Creates a System.Web.UI.WebControls.DropDownList control filled with the list of zones on the page to which the user can add Web Parts.
Public method DataBind() (Inherited from CompositeControl.)
Protected method DataBind(Boolean) (Inherited from Control.)
Protected method DataBindChildren (Inherited from Control.)
Public method Dispose (Inherited from Control.)
Protected method EnsureChildControls (Inherited from Control.)
Protected method EnsureID (Inherited from Control.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method FindControl(String) (Inherited from Control.)
Protected method FindControl(String, Int32) (Inherited from Control.)
Public method Focus (Inherited from Control.)
Protected method GetDesignModeState (Inherited from Control.)
Public method GetEffectiveChromeType (Inherited from WebZone.)
Public method GetHashCode (Inherited from Object.)
Public method GetRouteUrl(Object) (Inherited from Control.)
Public method GetRouteUrl(RouteValueDictionary) (Inherited from Control.)
Public method GetRouteUrl(String, Object) (Inherited from Control.)
Public method GetRouteUrl(String, RouteValueDictionary) (Inherited from Control.)
Public methodStatic member GetShowExtensibleToolPaneEvent Returns a string of ECMAScript (such as JavaScript) which, if executed on the client, causes the extensible tool pane to open for the specified Web Part.
Public methodStatic member GetShowToolPaneEvent(WebPart, ToolPane.ToolPaneView) Obsolete. Returns a string of ECMAScript (such as JavaScript) which, if executed on the client, causes a tool pane to open in the specified view for the specified Web Part.
Public methodStatic member GetShowToolPaneEvent(WebPart, WebPartDisplayMode) Returns a string of ECMAScript (such as JavaScript) which, if executed on the client, causes a tool pane to open in the specified view for the specified Web Part.
Public method GetType (Inherited from Object.)
Public method GetUniqueIDRelativeTo (Inherited from Control.)
Public method HasControls (Inherited from Control.)
Protected method HasEvents (Inherited from Control.)
Public method InsertToolPart Adds the specified ToolPart to the tool pane.
Protected method InvalidateEditorParts (Inherited from EditorZoneBase.)
Protected method IsLiteralContent (Inherited from Control.)
Protected method LoadControlState (Inherited from Control.)
Protected method LoadViewState (Inherited from EditorZoneBase.)
Protected method MapPathSecure (Inherited from Control.)
Protected method MemberwiseClone (Inherited from Object.)
Public method MergeStyle (Inherited from WebControl.)
Protected method OnBubbleEvent (Inherited from Control.)
Protected method OnDataBinding (Inherited from Control.)
Protected method OnDisplayModeChanged (Overrides EditorZoneBase.OnDisplayModeChanged(Object, WebPartDisplayModeEventArgs).)
Protected method OnInit Called to initialize the ToolPane and register it with the webpartpage (Overrides ToolZone.OnInit(EventArgs).)
Protected method OnLoad (Overrides Control.OnLoad(EventArgs).)
Protected method OnPreRender Before rendering the toolpane. Called directly by the ASP.NET engine. (Overrides EditorZoneBase.OnPreRender(EventArgs).)
Protected method OnSelectedWebPartChanged (Overrides EditorZoneBase.OnSelectedWebPartChanged(Object, WebPartEventArgs).)
Protected method OnUnload (Inherited from Control.)
Protected method OpenFile (Inherited from Control.)
Protected method RaiseBubbleEvent (Inherited from Control.)
Protected method RaisePostBackEvent (Inherited from EditorZoneBase.)
Protected method RecreateChildControls (Inherited from CompositeControl.)
Protected method RemovedControl (Inherited from Control.)
Public method RemoveToolPart Removes a ToolPart from the tool pane.
Protected method Render Renders the toolpane. Called directly by the ASP.NET engine. (Overrides EditorZoneBase.Render(HtmlTextWriter).)
Public method RenderBeginTag (Inherited from WebZone.)
Protected method RenderBody (Inherited from EditorZoneBase.)
Protected method RenderChildren (Inherited from Control.)
Protected method RenderContents (Inherited from WebZone.)
Public method RenderControl(HtmlTextWriter) (Inherited from Control.)
Protected method RenderControl(HtmlTextWriter, ControlAdapter) (Inherited from Control.)
Public method RenderEndTag (Inherited from WebControl.)
Protected method RenderFooter (Inherited from ToolZone.)
Protected method RenderHeader (Inherited from ToolZone.)
Protected method RenderVerb (Inherited from ToolZone.)
Protected method RenderVerbs (Inherited from EditorZoneBase.)
Protected method ResolveAdapter (Inherited from Control.)
Public method ResolveClientUrl (Inherited from Control.)
Public method ResolveUrl (Inherited from Control.)
Protected method SaveControlState (Inherited from Control.)
Protected method SaveViewState (Inherited from EditorZoneBase.)
Protected method SetDesignModeState (Inherited from Control.)
Public method SetRenderMethodDelegate (Inherited from Control.)
Public method ToString (Inherited from Object.)
Protected method TrackViewState (Inherited from EditorZoneBase.)

Top

Events

  Name Description
Public event DataBinding (Inherited from Control.)
Public event Disposed (Inherited from Control.)
Public event ErrorOccurred
Public event Init (Inherited from Control.)
Public event Load (Inherited from Control.)
Public event PreRender (Inherited from Control.)
Public event Unload (Inherited from Control.)
Public event ViewChanged
Public event ViewChanging

Top

Explicit interface implementations

  Name Description
Explicit interface implemetationPrivate method IParserAccessor.AddParsedSubObject (Inherited from Control.)
Explicit interface implemetationPrivate property IControlBuilderAccessor.ControlBuilder (Inherited from Control.)
Explicit interface implemetationPrivate property IDataBindingsAccessor.DataBindings (Inherited from Control.)
Explicit interface implemetationPrivate property IExpressionsAccessor.Expressions (Inherited from Control.)
Explicit interface implemetationPrivate method IAttributeAccessor.GetAttribute (Inherited from WebControl.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.GetDesignModeState (Inherited from Control.)
Explicit interface implemetationPrivate property IDataBindingsAccessor.HasDataBindings (Inherited from Control.)
Explicit interface implemetationPrivate property IExpressionsAccessor.HasExpressions (Inherited from Control.)
Explicit interface implemetationPrivate method IPostBackEventHandler.RaisePostBackEvent (Inherited from ToolZone.)
Explicit interface implemetationPrivate method ICompositeControlDesignerAccessor.RecreateChildControls (Inherited from CompositeControl.)
Explicit interface implemetationPrivate method IAttributeAccessor.SetAttribute (Inherited from WebControl.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.SetDesignModeState (Inherited from Control.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.SetOwnerControl (Inherited from Control.)
Explicit interface implemetationPrivate property IControlDesignerAccessor.UserData (Inherited from Control.)

Top

See also

Reference

ToolPane class

Microsoft.SharePoint.WebPartPages namespace