SearchScope Enum

The SearchScope enumeration is used to set which screens within a Screen Profile are searched for a pane. The search ends when a match is found. The result is passed to the ShowContent/HideContent API. SearchScope has four values that you can use to set the boundaries for the screen search:

• Self (0): (Default) Searches for a matching pane or the content within the layout that called the ShowContent or HideContent API. If SearchScope is not specified, "Self" is the default.
  • ShowContent: When SearchScope = Self, the layout that initiated the call is searched for a matching pane, whether it is the top level layout or a nested (embedded) layout.
  • HideContent: When SearchScope = Self, HideContent searches for matching content within the panes of the layout (top level or nested layout) from which the HideContent call was made. If the content is not found, a message is logged.
• AllScreens (1): All screens within the Screen Profile are searched for a matching pane or content. The search ends when a match is found. Note that nested layouts are not searched, only the layouts assigned to screens (not layouts embedded in another layout). The Search order is:
  • Source Screen (screen from which the call originated)
  • Primary Screen as designated in the Screen Profile
  • Any additional screens are searched in alphabetical order.
  • Nested layouts are not searched.
  • If a matching pane is not found:
    • ShowContent places the content in the default pane of the source screen.
    • HideContent logs a message that the content was not found.
• SourceScreen (2): The search is limited to the screen from which the ShowContent/HideContent call originated. Note that nested layouts are not searched, only the layout assigned to the source screen (not layouts embedded in it). If a matching pane is not found:
  • ShowContent places the content in the default pane of the source screen.
  • HideContent logs a message that the content was not found.
• PrimaryScreen (3): The search is limited to the Primary Screen. Note that nested layouts are not searched, only the layout assigned to the primary screen (not layouts embedded in it). If a matching pane is not found:
  • ShowContent places the content in the default pane of the primary screen.
  • HideContent logs a message that the content was not found.

SearchScope

namespace ArchestrA.Client.ViewApp
{
    /// <summary>
    /// Enum for Search scope
    /// </summary>
    public enum SearchScope : int
    {
         /// <summary>
        /// Self
        /// </summary>
        Self = 0,
        /// <summary>
        /// All screens
        /// </summary>
        AllScreens = 1,
        /// <summary>
        /// The source screen
        /// </summary>
        SourceScreen = 2,
        /// <summary>
        /// The primary screen
        /// </summary>
        PrimaryScreen = 3
    }
}