FoodCandy!

WebPartManager Class Reference

Represents a webpart manager. More...

List of all members.


Public Member Functions

 WebPartManager ()
 Initializes a new instance of the Wilco::Web::UI::WebControls::WebParts::WebPartManager class.
WebPartPanel CreateWebPartPanel (Control childControl)
 Creates a generic webpart panel for the specified control.
void AddWebPartPanel (WebPartPanel panel, WebPartZone zone, int zoneIndex)
 Programmatically adds a webpart panel to a zone at the specified index.
void MoveWebPartPanel (WebPartPanel panel, WebPartZone zone, int zoneIndex)
 Moves a webpart panel to the specified zone at the specified index.
void RemoveWebPartPanel (WebPartPanel panel)
 Removes a webpart panel from the page.

Static Public Member Functions

static bool SupportsClientSideDragDrop (Page page)
 Checks whether the client supports client side drag and drop.
static WebPartManager GetCurrentWebPartManager (Page page)
 Gets the current webpart manager on the specified page.

Protected Member Functions

override ControlCollection CreateControlCollection ()
 Creates the control collection.
override void OnInit (EventArgs e)
 Raises the System::Web::UI::Control::Init event.
override void OnPreRender (EventArgs e)
 Raises the System::Web::UI::Control::PreRender event.
override void Render (HtmlTextWriter writer)
 Renders the control.
override bool OnBubbleEvent (object source, EventArgs args)
 Determines whether the event for the server control is passed up the page's UI server control hierarchy.
virtual void OnWebPartPanelCommand (WebPartPanelEventArgs e)
 Raises the Wilco::Web::UI::WebControls::WebParts::WebPartManager::WebPartPanelCommand event.
virtual void OnWebPartPanelFrameStateChanged (WebPartPanelEventArgs e)
 Raises the Wilco::Web::UI::WebControls::WebParts::WebPartManager::WebPartPanelFrameStateChanged event.
virtual void OnWebPartPanelMoved (WebPartPanelMovedEventArgs e)
 Raises the Wilco::Web::UI::WebControls::WebParts::WebPartManager::WebPartPanelMoved event.
virtual void OnWebPartPanelRemoved (WebPartPanelEventArgs e)
 Raises the Wilco::Web::UI::WebControls::WebParts::WebPartManager::WebPartPanelRemoved event.

Properties

string DragObjectCssClass
 Gets or sets the CSS class of the drag object.
string SplitterObjectCssClass
 Gets or sets the CSS class of the splitter object.
override ControlCollection Controls
 Gets the collection of child controls.
WebPartZoneCollection Zones
 Gets the collection of zones.
WebPartPanelCollection WebPartPanels
 Gets the webpart panels.

Events

event WebPartPanelEventHandler WebPartPanelCommand
 Occurs when a webpart panel command is activated.
event WebPartPanelEventHandler WebPartPanelFrameStateChanged
 Occurs when a webpart panel's frame state is changed.
event WebPartPanelMovedEventHandler WebPartPanelMoved
 Occurs when a webpart panel is moved.
event WebPartPanelEventHandler WebPartPanelRemoved
 Occurs when a webpart panel is removed.

Classes

class  WebPartManagerControlCollection
 Represents a collection of controls for a webpart manager.
class  WebPartPanelZoneIndexComparer
 Represents a comparer which can compare webpart panel zone indices.

Detailed Description

Represents a webpart manager.


Member Function Documentation

void AddWebPartPanel WebPartPanel  panel,
WebPartZone  zone,
int  zoneIndex
 

Programmatically adds a webpart panel to a zone at the specified index.

Parameters:
panel 
zone 
zoneIndex 

override ControlCollection CreateControlCollection  )  [protected]
 

Creates the control collection.

Returns:

WebPartPanel CreateWebPartPanel Control  childControl  ) 
 

Creates a generic webpart panel for the specified control.

Parameters:
childControl 
Returns:

static WebPartManager GetCurrentWebPartManager Page  page  )  [static]
 

Gets the current webpart manager on the specified page.

Parameters:
page 
Returns:

void MoveWebPartPanel WebPartPanel  panel,
WebPartZone  zone,
int  zoneIndex
 

Moves a webpart panel to the specified zone at the specified index.

Parameters:
panel 
zone 
zoneIndex 

override bool OnBubbleEvent object  source,
EventArgs  args
[protected]
 

Determines whether the event for the server control is passed up the page's UI server control hierarchy.

Parameters:
source The source of the event.
args An System::EventArgs object that contains the event data.
Returns:
true if the event has been canceled; otherwise, false. The default is false.

override void OnInit EventArgs  e  )  [protected]
 

Raises the System::Web::UI::Control::Init event.

Parameters:
e 

override void OnPreRender EventArgs  e  )  [protected]
 

Raises the System::Web::UI::Control::PreRender event.

Parameters:
e 

virtual void OnWebPartPanelCommand WebPartPanelEventArgs  e  )  [protected, virtual]
 

Raises the Wilco::Web::UI::WebControls::WebParts::WebPartManager::WebPartPanelCommand event.

Parameters:
e 

virtual void OnWebPartPanelFrameStateChanged WebPartPanelEventArgs  e  )  [protected, virtual]
 

Raises the Wilco::Web::UI::WebControls::WebParts::WebPartManager::WebPartPanelFrameStateChanged event.

Parameters:
e 

virtual void OnWebPartPanelMoved WebPartPanelMovedEventArgs  e  )  [protected, virtual]
 

Raises the Wilco::Web::UI::WebControls::WebParts::WebPartManager::WebPartPanelMoved event.

Parameters:
e 

virtual void OnWebPartPanelRemoved WebPartPanelEventArgs  e  )  [protected, virtual]
 

Raises the Wilco::Web::UI::WebControls::WebParts::WebPartManager::WebPartPanelRemoved event.

Parameters:
e 

void RemoveWebPartPanel WebPartPanel  panel  ) 
 

Removes a webpart panel from the page.

Parameters:
panel The panel to remove.

override void Render HtmlTextWriter  writer  )  [protected]
 

Renders the control.

Parameters:
writer 

static bool SupportsClientSideDragDrop Page  page  )  [static]
 

Checks whether the client supports client side drag and drop.

Parameters:
page 
Returns:

The documentation for this class was generated from the following file:
  • WebPartManager.cs
© FoodCandy, 2006-2007, All Rights Reserved | FoodCandy | Sun Oct 7 10:48:54 2007 | Doxygen 1.4.6-NO