ActionsPane Interface

 

Represents a custom user interface for the Document Actions task pane in a document-level customization for Word or Excel.

Namespace:   Microsoft.Office.Tools
Assembly:  Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

[GuidAttribute("b835a67a-c3c0-45ba-9a3f-c878bf531dd5")]
public interface ActionsPane : IDisposable

NameDescription
System_CAPS_pubpropertyAccessibilityObject

Gets the AccessibleObject that is assigned to the actions pane.

System_CAPS_pubpropertyAccessibleDefaultActionDescription

Gets or sets the default action description of the actions pane. This description is used by accessibility client applications.

System_CAPS_pubpropertyAccessibleDescription

Gets or sets the accessible description of the actions pane. This description is used by accessibility client applications.

System_CAPS_pubpropertyAccessibleName

Gets or sets the accessible name of the actions pane. This name is used by accessibility client applications.

System_CAPS_pubpropertyAccessibleRole

Gets or sets the accessible role of the actions pane.

System_CAPS_pubpropertyActiveControl

Gets or sets the active control on the actions pane.

System_CAPS_pubpropertyAllowDrop

Gets or sets a value that indicates whether the actions pane can accept data that the user drags onto it.

System_CAPS_pubpropertyAnchor

Gets or sets the edges of the container to which the actions pane is bound and determines how the user control is resized with its parent.

System_CAPS_pubpropertyAutoRecover

Gets or sets a value that indicates whether the actions pane solution automatically re-attaches to the document when it is detached.

System_CAPS_pubpropertyAutoScaleDimensions

Gets or sets the dimensions that the actions pane was designed to.

System_CAPS_pubpropertyAutoScaleMode

Gets or sets the automatic scaling mode of the actions pane.

System_CAPS_pubpropertyAutoScroll

Gets or sets a value indicating whether the actions pane enables the user to scroll to any controls placed outside of its visible boundaries.

System_CAPS_pubpropertyAutoScrollMargin

Gets or sets the size of the auto-scroll margin for the actions pane.

System_CAPS_pubpropertyAutoScrollMinSize

Gets or sets the minimum size of the auto-scroll for the actions pane.

System_CAPS_pubpropertyAutoScrollOffset

Gets or sets where the actions pane is scrolled to when the ScrollControlIntoView method is called.

System_CAPS_pubpropertyAutoScrollPosition

Gets or sets the location of the auto-scroll position for the actions pane.

System_CAPS_pubpropertyAutoSize

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not supported by the actions pane.

System_CAPS_pubpropertyAutoSizeMode

Gets or sets the mode by which the actions pane control automatically resizes itself.

System_CAPS_pubpropertyAutoValidate

Gets or sets a value that indicates whether controls in the actions pane will be automatically validated when the focus changes.

System_CAPS_pubpropertyBackColor

Gets or sets the background color for the actions pane.

System_CAPS_pubpropertyBackgroundImage

Gets or sets the background image displayed in the actions pane.

System_CAPS_pubpropertyBackgroundImageLayout

Gets or sets the position and behavior of a background image in the actions pane.

System_CAPS_pubpropertyBindingContext

Gets or sets an object that is used to keep all controls on the actions pane that are bound to the same data source synchronized.

System_CAPS_pubpropertyBorderStyle

Gets or sets the border style of the actions pane.

System_CAPS_pubpropertyBottom

Gets the distance, in pixels, between the bottom edge of the actions pane and the top edge of its container's client area.

System_CAPS_pubpropertyBounds

Gets or sets the size and location of the actions pane control including its nonclient elements, in pixels, relative to its parent.

System_CAPS_pubpropertyCanFocus

Gets a value indicating whether the actions pane can receive focus.

System_CAPS_pubpropertyCanSelect

Gets a value indicating whether the actions pane can be selected.

System_CAPS_pubpropertyCapture

Gets or sets a value indicating whether the actions pane has captured the mouse.

System_CAPS_pubpropertyCausesValidation

Gets or sets a value indicating whether the actions pane causes validation to be performed on any controls that require validation when it receives focus.

System_CAPS_pubpropertyClientRectangle

Gets the rectangle that represents the client area of the actions pane.

System_CAPS_pubpropertyClientSize

Gets or sets the height and width of the client area of the actions pane.

System_CAPS_pubpropertyCompanyName

Gets the name of the company or creator of the application containing the actions pane.

System_CAPS_pubpropertyContainer

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not supported by the actions pane.

System_CAPS_pubpropertyContainsFocus

Gets a value indicating whether the actions pane, or one of its child controls, currently has the input focus.

System_CAPS_pubpropertyContextMenu

Gets or sets the shortcut menu associated with the actions pane.

System_CAPS_pubpropertyContextMenuStrip

Gets or sets the ContextMenuStrip associated with the actions pane.

System_CAPS_pubpropertyControls

Gets the collection of controls contained within the actions pane.

System_CAPS_pubpropertyCreated

Gets a value indicating whether the actions pane has been created.

System_CAPS_pubpropertyCurrentAutoScaleDimensions

Gets the current run-time dimensions of the screen.

System_CAPS_pubpropertyCursor

Gets or sets the cursor that is displayed when the mouse pointer is over the actions pane.

System_CAPS_pubpropertyDataBindings

Gets the data bindings for the actions pane.

System_CAPS_pubpropertyDisplayRectangle

Gets the rectangle that represents the display area of the actions pane.

System_CAPS_pubpropertyDisposing

Gets a value indicating whether the actions pane is in the process of disposing.

System_CAPS_pubpropertyDock

Gets or sets which actions pane control borders are docked to its parent and determines how the actions pane control is resized with its parent.

System_CAPS_pubpropertyEnabled

Gets or sets a value indicating whether the actions pane can respond to user interaction.

System_CAPS_pubpropertyFocused

Gets a value indicating whether the actions pane has input focus.

System_CAPS_pubpropertyFont

Gets or sets the font of the text displayed by the actions pane.

System_CAPS_pubpropertyForeColor

Gets or sets the foreground color of the actions pane.

System_CAPS_pubpropertyHandle

Gets the window handle that the actions pane control is bound to.

System_CAPS_pubpropertyHasChildren

Gets a value that indicates whether the control contains one or more child controls.

System_CAPS_pubpropertyHeight

Gets or sets the height of the actions pane control.

System_CAPS_pubpropertyHorizontalScroll

Gets the characteristics associated with the horizontal scroll bar.

System_CAPS_pubpropertyImeMode

Gets or sets the Input Method Editor (IME) mode of the actions pane.

System_CAPS_pubpropertyInvokeRequired

Gets a value indicating whether the caller must call an invoke method when making method calls to the actions pane control because the caller is on a different thread than the one the actions pane control was created on.

System_CAPS_pubpropertyIsAccessible

Gets or sets a value that indicates whether the actions pane is visible to accessibility applications.

System_CAPS_pubpropertyIsDisposed

Gets a value that indicates whether the actions pane control has been disposed of.

System_CAPS_pubpropertyIsHandleCreated

Gets a value that indicates whether the actions pane control has a handle associated with it.

System_CAPS_pubpropertyIsMirrored

Gets a value that indicates whether the actions pane is mirrored.

System_CAPS_pubpropertyLayoutEngine

Gets a cached instance of the actions pane control's layout engine.

System_CAPS_pubpropertyLeft

Gets or sets the distance, in pixels, between the left edge of the actions pane control and the left edge of its container's client area.

System_CAPS_pubpropertyLocation

Gets or sets the coordinates of the upper-left corner of the actions pane relative to the upper-left corner of its container.

System_CAPS_pubpropertyMargin

Gets or sets the space between controls.

System_CAPS_pubpropertyMaximumSize

Gets or sets the size that is the upper limit that GetPreferredSize can specify.

System_CAPS_pubpropertyMinimumSize

Gets or sets the size that is the lower limit that GetPreferredSize can specify.

System_CAPS_pubpropertyName

Gets or sets the name of the actions pane control.

System_CAPS_pubpropertyOrientation

Gets a value that indicates whether the placement of the actions pane is vertical or horizontal.

System_CAPS_pubpropertyPadding

Gets or sets padding within the actions pane.

System_CAPS_pubpropertyParent

Gets or sets the parent container of the actions pane.

System_CAPS_pubpropertyParentForm

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not supported by the actions pane.

System_CAPS_pubpropertyPreferredSize

Gets the size of the rectangular area into which the actions pane can fit.

System_CAPS_pubpropertyProductName

Gets the product name of the assembly that contains the actions pane.

System_CAPS_pubpropertyProductVersion

Gets the version of the assembly that contains the actions pane.

System_CAPS_pubpropertyRecreatingHandle

Gets a value that indicates whether the actions pane control is currently re-creating its handle.

System_CAPS_pubpropertyRegion

Gets or sets the window region associated with the actions pane.

System_CAPS_pubpropertyRight

Gets the distance, in pixels, between the right edge of the actions pane and the left edge of its container's client area.

System_CAPS_pubpropertyRightToLeft

Gets or sets a value indicating whether the actions pane's elements are aligned to support locales using right-to-left fonts.

System_CAPS_pubpropertySite

Gets or sets the site of the actions pane.

System_CAPS_pubpropertySize

Gets or sets the height and width of the actions pane control.

System_CAPS_pubpropertyStackOrder

Gets or sets a value that indicates the direction that the controls are stacked on the actions pane.

System_CAPS_pubpropertyTabIndex

Gets or sets the tab order of the actions pane within its container.

System_CAPS_pubpropertyTabStop

Gets or sets a value indicating whether the user can give the focus to the actions pane by using the TAB key.

System_CAPS_pubpropertyTag

Gets or sets the object that contains data about the actions pane.

System_CAPS_pubpropertyTop

Gets or sets the distance, in pixels, between the top edge of the actions pane control and the top edge of its container's client area.

System_CAPS_pubpropertyTopLevelControl

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not supported by the actions pane.

System_CAPS_pubpropertyUseWaitCursor

Gets or sets a value indicating whether to use the wait cursor for the actions pane and all child controls.

System_CAPS_pubpropertyVerticalScroll

Gets the characteristics associated with the vertical scroll bar.

System_CAPS_pubpropertyVisible

Gets or sets a value that indicates whether the ActionsPane is visible.

System_CAPS_pubpropertyWidth

Gets or sets the width of the actions pane control.

NameDescription
System_CAPS_pubmethodBeginInit()

This API supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubmethodBeginInvoke(Delegate)

Executes the specified delegate asynchronously on the thread that the actions pane control's underlying handle was created on.

System_CAPS_pubmethodBeginInvoke(Delegate, Object[])

Executes the specified delegate asynchronously with the specified arguments, on the thread that the actions pane control's underlying handle was created on.

System_CAPS_pubmethodBringToFront()

Brings the actions pane control to the front of the z-order.

System_CAPS_pubmethodClear()

Detaches the actions pane solution from the document.

System_CAPS_pubmethodContains(Control)

Returns a value that indicates whether the specified control is a child of the actions pane.

System_CAPS_pubmethodCreateControl()

Forces the creation of the visible actions pane control, including the creation of the handle and any visible child controls.

System_CAPS_pubmethodCreateGraphics()

Creates the Graphics for the actions pane control.

System_CAPS_pubmethodDispose()

(Inherited from IDisposable.)

System_CAPS_pubmethodDoDragDrop(Object, DragDropEffects)

Begins a drag-and-drop operation.

System_CAPS_pubmethodDrawToBitmap(Bitmap, Rectangle)

Supports rendering to the specified bitmap.

System_CAPS_pubmethodEndInit()

This API supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubmethodEndInvoke(IAsyncResult)

Retrieves the return value of the specified asynchronous operation.

System_CAPS_pubmethodFindForm()

Retrieves the form that the actions pane control is on.

System_CAPS_pubmethodFocus()

Sets input focus to the actions pane.

System_CAPS_pubmethodGetChildAtPoint(Point)

Retrieves the child control that is located at the specified coordinates.

System_CAPS_pubmethodGetChildAtPoint(Point, GetChildAtPointSkip)

Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type.

System_CAPS_pubmethodGetContainerControl()

Returns the next ContainerControl up the control's chain of parent controls.

System_CAPS_pubmethodGetNextControl(Control, Boolean)

Retrieves the next control forward or back in the tab order of child controls.

System_CAPS_pubmethodGetPreferredSize(Size)

Retrieves the size of a rectangular area into which the actions pane can be fitted.

System_CAPS_pubmethodHide()

Removes the ActionsPane and the controls from the task pane user interface, but leaves the task pane visible.

System_CAPS_pubmethodInvalidate()

Invalidates the entire surface of the actions pane and causes the actions pane to be redrawn.

System_CAPS_pubmethodInvalidate(Boolean)

Invalidates the entire surface of the actions pane and causes a paint message to be sent to the actions pane. Optionally, invalidates the child controls assigned to the actions pane.

System_CAPS_pubmethodInvalidate(Rectangle)

Invalidates the specified region of the actions pane (adds it to the actions pane's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the actions pane.

System_CAPS_pubmethodInvalidate(Rectangle, Boolean)

Invalidates the specified region of the actions pane (adds it to the actions pane's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the actions pane. Optionally, invalidates the child controls assigned to the actions pane.

System_CAPS_pubmethodInvalidate(Region)

Invalidates the specified region of the actions pane (adds it to the actions pane's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the actions pane.

System_CAPS_pubmethodInvalidate(Region, Boolean)

Invalidates the specified region of the actions pane (adds it to the actions pane's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the actions pane. Optionally, invalidates the child controls assigned to the actions pane.

System_CAPS_pubmethodInvoke(Delegate)

Executes the specified delegate on the thread that owns the actions pane's underlying window handle.

System_CAPS_pubmethodInvoke(Delegate, Object[])

Executes the specified delegate, on the thread that owns the actions pane's underlying window handle, with the specified list of arguments.

System_CAPS_pubmethodPerformAutoScale()

Performs scaling of the actions pane and its children.

System_CAPS_pubmethodPerformLayout()

Forces the actions pane to apply layout logic to all its child controls.

System_CAPS_pubmethodPerformLayout(Control, String)

Forces the actions pane to apply layout logic to all its child controls.

System_CAPS_pubmethodPointToClient(Point)

Computes the location of the specified screen point into client coordinates.

System_CAPS_pubmethodPointToScreen(Point)

Computes the location of the specified client point into screen coordinates.

System_CAPS_pubmethodPreProcessControlMessage(Message)

Preprocesses keyboard or input messages within the message loop before they are dispatched.

System_CAPS_pubmethodPreProcessMessage(Message)

Preprocesses keyboard or input messages within the message loop before they are dispatched.

System_CAPS_pubmethodRectangleToClient(Rectangle)

Computes the size and location of the specified screen rectangle in client coordinates.

System_CAPS_pubmethodRectangleToScreen(Rectangle)

Computes the size and location of the specified client rectangle in screen coordinates.

System_CAPS_pubmethodRefresh()

Forces the actions pane to invalidate its client area and immediately redraw itself and any child controls.

System_CAPS_pubmethodResetText()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not supported by the actions pane.

System_CAPS_pubmethodResumeLayout()

Resumes usual layout logic.

System_CAPS_pubmethodResumeLayout(Boolean)

Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests.

System_CAPS_pubmethodScale(SizeF)

Scales the actions pane and all child controls by the specified scaling factor.

System_CAPS_pubmethodScrollControlIntoView(Control)

Scrolls the specified child control into view.

System_CAPS_pubmethodSelect()

Activates the actions pane.

System_CAPS_pubmethodSelectNextControl(Control, Boolean, Boolean, Boolean, Boolean)

Activates the next control.

System_CAPS_pubmethodSendToBack()

Sends the actions pane control to the back of the z-order.

System_CAPS_pubmethodSetAutoScrollMargin(Int32, Int32)

Sets the size of the auto-scroll margins.

System_CAPS_pubmethodSetBounds(Int32, Int32, Int32, Int32)

Sets the bounds of the actions pane to the specified location and size.

System_CAPS_pubmethodSetBounds(Int32, Int32, Int32, Int32, BoundsSpecified)

Sets the specified bounds of the actions pane to the specified location and size.

System_CAPS_pubmethodShow()

Displays the ActionsPane on the task pane, including all controls that have been added to the ActionsPane, but does not display the task pane if the task pane is not visible.

System_CAPS_pubmethodSuspendLayout()

Temporarily suspends the layout logic for the actions pane.

System_CAPS_pubmethodUpdate()

Causes the actions pane to redraw the invalidated regions within its client area.

System_CAPS_pubmethodValidate()

Verifies the contents of the actions pane by causing the Validating and Validated events to occur, in that order.

System_CAPS_pubmethodValidate(Boolean)

Verifies the contents of the actions pane; conditionally dependent on whether automatic validation is turned on.

System_CAPS_pubmethodValidateChildren()

Causes all of the child controls that support validation to validate their data.

System_CAPS_pubmethodValidateChildren(ValidationConstraints)

Causes all of the child controls that support validation to validate their data.

NameDescription
System_CAPS_pubeventAutoSizeChanged

This API supports the product infrastructure and is not intended to be used directly from your code. This event is not supported by the actions pane.

System_CAPS_pubeventAutoValidateChanged

Occurs when the AutoValidate property changes.

System_CAPS_pubeventBackColorChanged

Occurs when the value of the BackColor property changes.

System_CAPS_pubeventBackgroundImageChanged

Occurs when the value of the BackgroundImage property changes.

System_CAPS_pubeventBackgroundImageLayoutChanged

Occurs when the BackgroundImageLayout property changes.

System_CAPS_pubeventBindingContextChanged

Occurs when the value of the BindingContext property changes.

System_CAPS_pubeventCausesValidationChanged

Occurs when the value of the CausesValidation property changes.

System_CAPS_pubeventChangeUICues

Occurs when the focus or keyboard user interface (UI) cues change.

System_CAPS_pubeventClick

Occurs when the actions pane is clicked.

System_CAPS_pubeventClientSizeChanged

Occurs when the value of the ClientSize property changes.

System_CAPS_pubeventContextMenuChanged

Occurs when the value of the ContextMenu property changes.

System_CAPS_pubeventContextMenuStripChanged

Occurs when the value of the ContextMenuStrip property changes.

System_CAPS_pubeventControlAdded

Occurs when a new control is added to the Controls collection.

System_CAPS_pubeventControlRemoved

Occurs when a control is removed from the Controls collection.

System_CAPS_pubeventCursorChanged

Occurs when the value of the Cursor property changes.

System_CAPS_pubeventDisposed

Occurs when the actions pane is disposed.

System_CAPS_pubeventDockChanged

Occurs when the value of the Dock property changes.

System_CAPS_pubeventDoubleClick

Occurs when the actions pane is double-clicked.

System_CAPS_pubeventDragDrop

Occurs when a drag-and-drop operation is completed.

System_CAPS_pubeventDragEnter

Occurs when an object is dragged into the actions pane's bounds.

System_CAPS_pubeventDragLeave

Occurs when an object is dragged out of the actions pane's bounds.

System_CAPS_pubeventDragOver

Occurs when an object is dragged over the actions pane's bounds.

System_CAPS_pubeventEnabledChanged

Occurs when the Enabled property value has changed.

System_CAPS_pubeventEnter

Occurs when the actions pane is entered.

System_CAPS_pubeventFontChanged

Occurs when the Font property value changes.

System_CAPS_pubeventForeColorChanged

Occurs when the ForeColor property value changes.

System_CAPS_pubeventGiveFeedback

Occurs during a drag operation.

System_CAPS_pubeventGotFocus

Occurs when the actions pane receives focus.

System_CAPS_pubeventHandleCreated

Occurs when a handle is created for the actions pane.

System_CAPS_pubeventHandleDestroyed

Occurs when the actions pane's handle is in the process of being destroyed.

System_CAPS_pubeventHelpRequested

Occurs when the user requests help for the actions pane.

System_CAPS_pubeventImeModeChanged

Occurs when the ImeMode property changes.

System_CAPS_pubeventInvalidated

Occurs when the actions pane's display requires redrawing.

System_CAPS_pubeventKeyDown

Occurs when a key is pressed while the actions pane has focus.

System_CAPS_pubeventKeyPress

Occurs when a key is pressed while the actions pane has focus.

System_CAPS_pubeventKeyUp

Occurs when a key is released while the actions pane has focus.

System_CAPS_pubeventLayout

Occurs when the actions pane should reposition its child controls.

System_CAPS_pubeventLeave

Occurs when the input focus leaves the actions pane.

System_CAPS_pubeventLoad

Occurs before the actions pane becomes visible for the first time.

System_CAPS_pubeventLocationChanged

Occurs when the Location property value has changed.

System_CAPS_pubeventLostFocus

Occurs when the actions pane loses focus.

System_CAPS_pubeventMarginChanged

Occurs when the actions pane's margin changes.

System_CAPS_pubeventMouseCaptureChanged

Occurs when the actions pane loses or gains mouse capture.

System_CAPS_pubeventMouseClick

Occurs when the actions pane is clicked by the mouse.

System_CAPS_pubeventMouseDoubleClick

Occurs when the actions pane is double clicked by the mouse.

System_CAPS_pubeventMouseDown

Occurs when the mouse pointer is over the actions pane and a mouse button is pressed.

System_CAPS_pubeventMouseEnter

Occurs when the mouse pointer enters the actions pane.

System_CAPS_pubeventMouseHover

Occurs when the mouse pointer rests on the actions pane.

System_CAPS_pubeventMouseLeave

Occurs when the mouse pointer leaves the actions pane.

System_CAPS_pubeventMouseMove

Occurs when the mouse pointer is moved over the actions pane.

System_CAPS_pubeventMouseUp

Occurs when the mouse pointer is over the actions pane and a mouse button is released.

System_CAPS_pubeventMouseWheel

Occurs when the mouse wheel moves while the actions pane has focus.

System_CAPS_pubeventMove

Occurs when the actions pane is moved.

System_CAPS_pubeventOrientationChanged

Occurs when the Orientation of the actions pane changes.

System_CAPS_pubeventPaddingChanged

Occurs when the actions pane's padding changes.

System_CAPS_pubeventPaint

Occurs when the actions pane is redrawn.

System_CAPS_pubeventParentChanged

Occurs when the Parent property value changes.

System_CAPS_pubeventPreviewKeyDown

Occurs before the KeyDown event when a key is pressed while focus is on this control.

System_CAPS_pubeventQueryAccessibilityHelp

Occurs when an AccessibleObject is providing help to accessibility applications.

System_CAPS_pubeventQueryContinueDrag

Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled.

System_CAPS_pubeventRegionChanged

Occurs when the value of the Region property changes.

System_CAPS_pubeventResize

Occurs when the actions pane is resized.

System_CAPS_pubeventRightToLeftChanged

Occurs when the RightToLeft property value changes.

System_CAPS_pubeventScroll

Occurs when the user or code scrolls through the client area.

System_CAPS_pubeventSizeChanged

Occurs when the Size property value changes.

System_CAPS_pubeventStyleChanged

Occurs when the actions pane style changes.

System_CAPS_pubeventSystemColorsChanged

Occurs when the system colors change.

System_CAPS_pubeventTabIndexChanged

Occurs when the TabIndex property value changes.

System_CAPS_pubeventTabStopChanged

Occurs when the TabStop property value changes.

System_CAPS_pubeventValidated

Occurs when the actions pane is finished validating.

System_CAPS_pubeventValidating

Occurs when the actions pane is validating.

System_CAPS_pubeventVisibleChanged

Occurs when the Visible property value changes.

Every document-level customization for Excel or Word exposes an ActionsPane object. You can use this object to customize the user interface of the Document Actions task pane in a document-level project. To get the ActionsPane object, use the ActionsPane field of the ThisDocument class (for Word) or the ThisWorkbook class (for Excel) in your project. For more information, see Actions Pane Overview.

Each ActionsPane object extends an underlying Windows Forms UserControl that provides a user interface that you can customize. Most of the ActionsPane members correspond to members of the underlying UserControl. Use the following ActionsPane members to access actions pane-specific functionality:

  • Clear method. Use this method to detach the actions pane from the document or workbook.

  • AutoRecover property. Use this property to prevent or allow end users to detach the actions pane from the document or workbook.

  • Orientation property. Use this property to determine whether the actions pane is docked to the top or bottom of the document or workbook, or to the left or right of the document or workbook.

  • StackOrder property. Use this property to specify the direction that controls are stacked on the actions pane.

  • OrientationChanged event. Use this property to determine when the actions pane is docked to a different location.

System_CAPS_noteNote

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 or later. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: http://go.microsoft.com/fwlink/?LinkId=160658.

The following code example demonstrates how to create a simple actions pane that automatically adjusts the alignment of its contents. When the user changes the orientation of the actions pane by moving the actions pane to a different part of the application window, or the user clicks on a Button control in the actions pane, the Orientation property is used to determine the new value of the StackOrder property. To run this code, call the InitActionsPane method from the ThisWorkbook_Startup event handler of a document-level project for Excel.

private void InitActionsPane()
{
    Globals.ThisWorkbook.ActionsPane.Clear();
    Globals.ThisWorkbook.ActionsPane.Visible = true;
    Globals.ThisWorkbook.ActionsPane.AutoRecover = true;
    Globals.ThisWorkbook.ActionsPane.OrientationChanged +=
        new EventHandler(ActionsPane_OrientationChanged);
    ResetStackOrder();

    // Create the button that will update the stack order.
    Button button1 = new Button();
    button1.Text = "Change stack order";
    button1.Click += new EventHandler(button1_Click);

    // Create two more buttons that do nothing.
    Button button2 = new Button();
    button2.Text = "Button 2";
    Button button3 = new Button();
    button3.Text = "Button 3";

    Globals.ThisWorkbook.ActionsPane.Controls.AddRange(
        new Control[] { button1, button2, button3 });
}

// Switch the stack order according to the current orientation.
void button1_Click(object sender, EventArgs e)
{
    if (Globals.ThisWorkbook.ActionsPane.Orientation == 
        Orientation.Horizontal)
    {
        if (Globals.ThisWorkbook.ActionsPane.StackOrder == 
            Microsoft.Office.Tools.StackStyle.FromLeft)
        {
            Globals.ThisWorkbook.ActionsPane.StackOrder =
                Microsoft.Office.Tools.StackStyle.FromRight;
        }
        else
        {
            Globals.ThisWorkbook.ActionsPane.StackOrder =
                Microsoft.Office.Tools.StackStyle.FromLeft;
        }
    }
    else
    {
        if (Globals.ThisWorkbook.ActionsPane.StackOrder ==
            Microsoft.Office.Tools.StackStyle.FromTop)
        {
            Globals.ThisWorkbook.ActionsPane.StackOrder =
                Microsoft.Office.Tools.StackStyle.FromBottom;
        }
        else
        {
            Globals.ThisWorkbook.ActionsPane.StackOrder =
                Microsoft.Office.Tools.StackStyle.FromTop;
        }
    }
}

void ActionsPane_OrientationChanged(object sender, EventArgs e)
{
    ResetStackOrder();
}

// Readjust the stack order so that it matches the current orientation.
void ResetStackOrder()
{
    if (Globals.ThisWorkbook.ActionsPane.Orientation == 
        Orientation.Horizontal &&
       (Globals.ThisWorkbook.ActionsPane.StackOrder == 
           Microsoft.Office.Tools.StackStyle.FromTop ||
        Globals.ThisWorkbook.ActionsPane.StackOrder ==
           Microsoft.Office.Tools.StackStyle.FromBottom))
    {
        Globals.ThisWorkbook.ActionsPane.StackOrder =
            Microsoft.Office.Tools.StackStyle.FromLeft;
    }

    if (Globals.ThisWorkbook.ActionsPane.Orientation == 
        Orientation.Vertical &&
       (Globals.ThisWorkbook.ActionsPane.StackOrder ==
           Microsoft.Office.Tools.StackStyle.FromLeft ||
        Globals.ThisWorkbook.ActionsPane.StackOrder ==
           Microsoft.Office.Tools.StackStyle.FromRight))
    {
        Globals.ThisWorkbook.ActionsPane.StackOrder =
            Microsoft.Office.Tools.StackStyle.FromTop;
    }
}
Return to top
Show: