Using the ViewApp SDK

Use the ViewApp SDK to set the layout state (minimize/maximize the ViewApp window), close the ViewApp, and set the position of, and activate, a slide-in pane.

Methods and Enumerations

ActivateSlideInPane

The ActivateSlideInPane() method is used to activate the slide-in-pane. This method has two parameters:

Control: This is the framework element that triggers the ActivateSlideInPane action. In the Navigation hierarchy, it searches for the parent window that contains the element, and activates the slide-in pane at that level of the hierarchy.
PanePosition: This is an enumeration with four possible values (Left, Right, Top, Bottom). This determines which slide-in pane is activated.

ActivateSlideInPane	Copy Code
/// <summary> /// Activates Slide-In Pane (Left,Right,Top,Bottom) /// </summary> /// <param name="control">Reference to control that was added to the pane</param> /// <param name="slideInPanePosition">Slide-In Pane position</param> public abstract void ActivateSlideInPane(object control, SlideInPanePosition panePosition);

ActivateSlideInPane

Copy Code

   /// <summary>
   /// Activates Slide-In Pane (Left,Right,Top,Bottom)
   /// </summary>
   /// <param name="control">Reference to control that was added to the pane</param>
   /// <param name="slideInPanePosition">Slide-In Pane position</param>
   public abstract void ActivateSlideInPane(object control, SlideInPanePosition panePosition);

SetLayoutState

The SetLayoutState() method is used to maximize, minimize, and restore layouts when the user selects the corresponding button. This method has two parameters:

Control: This is the framework element that triggers the SetLayoutState action. In the Navigation hierarchy, it searches for the parent window that contains the element, and maximizes, minimizes, or restores the window at that level of the hierarchy.

WindowState: This is an enumeration from System.Windows.WindowState. It has three values:

Normal
Minimize
Restore

CloseLayout

The CloseLayout() method is used to close the Layout window. This method has one parameter:

Control: This is the framework element that triggers the CloseLayout action. In the Navigation hierarchy, it searches for the parent window that contains the element, and closes the layout at that level of the hierarchy.

CloseLayout	Copy Code
/// <summary> /// Closes the Layout Window /// </summary> /// <param name="control">object. For instance, FrameworkElement</param> public abstract void CloseLayout(object control);

SlideInPanePosition

The SlideInPanePosition enumeration is passed to the ActivateSlideInPane API. It has four values to set the position of the slide-in pane:

Top
Bottom
Left
Right

SlideInPanePosition	Copy Code
namespace ArchestrA.Client.ViewApp { using System.ComponentModel; /// <summary> /// Different types of pane's Slide-In position /// </summary> public enum SlideInPanePosition { /// <summary> /// Pane slide-in from left /// </summary> [Description("Left")] Left, /// <summary> /// Pane slide-in from Top /// </summary> [Description("Top")] Top, /// <summary> /// Pane slide-in from Right /// </summary> [Description("Right")] Right, /// <summary> /// Pane slide-in from Bottom /// </summary> [Description("Bottom")] Bottom } }

SlideInPanePosition

Copy Code

    namespace ArchestrA.Client.ViewApp
{
    using System.ComponentModel;
    /// <summary>
    /// Different types of pane's Slide-In position
    /// </summary>
    public enum SlideInPanePosition
    {
        /// <summary>
        /// Pane slide-in from left
        /// </summary>
        [Description("Left")]
        Left,
        /// <summary>
        /// Pane slide-in from Top
        /// </summary>
        [Description("Top")]
        Top,
        /// <summary>
        /// Pane slide-in from Right
        /// </summary>
        [Description("Right")]
        Right,
        /// <summary>
        /// Pane slide-in from Bottom
        /// </summary>
        [Description("Bottom")]
        Bottom
    }
}