Search Results for

    Show / Hide Table of Contents

    Class Help

    This command executes the Help system command

    Loads child commands containing context sensitive help on the system, menu items, role, and active views within the active layout

    Users can customise the help using the ItemHelpURL, ContextHelpURL, LayoutHelpURL, or RoleHelpURL
    Inheritance
    System.Object
    BaseHasChildren<EPCommandWithDescriptor>
    EPCommand
    EPCommandWithDescriptor
    Help
    Implements
    IHasChildren<EPCommandWithDescriptor>
    IHasChildren
    System.IDisposable
    IEPCommandWithDescriptor
    IEPCommand
    System.Windows.Input.ICommand
    ICommandDescriptor
    Inherited Members
    EPCommandWithDescriptor.ICommandDescriptor.Title
    EPCommandWithDescriptor.OverlayIconID
    EPCommandWithDescriptor.Type
    EPCommandWithDescriptor.ToolTip
    EPCommandWithDescriptor.Parameter
    EPCommandWithDescriptor.HelpURL
    EPCommand.ActiveDisplayerFromOwner
    EPCommand.ReloadChildrenOnEachOpen
    EPCommand.SetToggler(IHasToggleStatus)
    EPCommand.Seperator
    EPCommand.Owner
    EPCommand.CanExecuteChanged
    EPCommand.OnCanExecuteChanged()
    EPCommand.SubscribeToLayoutChange
    EPCommand.OnLayoutsChanged(IModelLayouHost, LayoutChangeEventArgs)
    EPCommand.ICommand.Execute(Object)
    EPCommand.ExternalExecute(Object)
    EPCommand.InternalExecuteAsync(Object)
    EPCommand.LockExecution
    EPCommand.ICommand.CanExecute(Object)
    EPCommand.ExternalCanExecute(Object)
    EPCommand.InternalCanExecuteAsync(Object)
    EPCommand.Toggler
    EPCommand.CustomType
    EPCommand.Key
    EPCommand.ModifierKeys
    EPCommand.GetModifierText(IEPCommand)
    EPCommand.RemoveEventHandlersOnDispose()
    EPCommand.Dispose(Boolean)
    EPCommand.Dispose()
    BaseHasChildren<EPCommandWithDescriptor>.Order
    BaseHasChildren<EPCommandWithDescriptor>.Children
    BaseHasChildren<EPCommandWithDescriptor>.AddChild(EPCommandWithDescriptor)
    BaseHasChildren<EPCommandWithDescriptor>.DeleteChild(EPCommandWithDescriptor)
    BaseHasChildren<EPCommandWithDescriptor>.ClearChildren()
    BaseHasChildren<EPCommandWithDescriptor>.Parent
    BaseHasChildren<EPCommandWithDescriptor>.AddChild(IHasChildren)
    BaseHasChildren<EPCommandWithDescriptor>.DeleteChild(IHasChildren)
    BaseHasChildren<EPCommandWithDescriptor>.IHasChildren.Children
    BaseHasChildren<EPCommandWithDescriptor>.IHasChildren.Parent
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: LemonEdge.Client.Core.Commands
    Assembly: ClientCore.dll
    Syntax
    [CommandDescriptorOptions(Commands.Help, null)]
    public class Help : EPCommandWithDescriptor, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptor

    Constructors

    Help(IModelLayoutCommon)

    Creates a new Help command

    Declaration
    public Help(IModelLayoutCommon owner)
    Parameters
    Type Name Description
    IModelLayoutCommon owner

    The owning context for this command

    Fields

    BASE_URL

    Declaration
    public const string BASE_URL = "https://web.lemonedge.com/help/"
    Field Value
    Type Description
    System.String

    Properties

    Description

    Declaration
    public override string Description { get; }
    Property Value
    Type Description
    System.String
    Overrides
    EPCommandWithDescriptor.Description

    HasChildCommands

    True - has all the context sensistive help as sub commands

    Declaration
    public override bool HasChildCommands { get; }
    Property Value
    Type Description
    System.Boolean
    Overrides
    EPCommand.HasChildCommands

    IconID

    The default Question system image

    Declaration
    public override Guid IconID { get; }
    Property Value
    Type Description
    System.Guid
    Overrides
    EPCommandWithDescriptor.IconID

    Title

    Help

    Declaration
    public override string Title { get; }
    Property Value
    Type Description
    System.String
    Overrides
    EPCommandWithDescriptor.Title

    Methods

    InternalCanExecute(Object)

    True - can always access help

    Declaration
    public override bool InternalCanExecute(object parameter)
    Parameters
    Type Name Description
    System.Object parameter

    The command parameter

    Returns
    Type Description
    System.Boolean

    True

    Overrides
    EPCommand.InternalCanExecute(Object)

    InternalExecute(Object)

    Loads the child commands into view

    Declaration
    public override void InternalExecute(object parameter)
    Parameters
    Type Name Description
    System.Object parameter

    The command parameter

    Overrides
    EPCommand.InternalExecute(Object)

    LoadChildrenAsync()

    Loads the child system, menu item, role, and active view help commands depending on the current context

    Declaration
    public override Task LoadChildrenAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    A task indicating the completion of the operation

    Overrides
    EPCommand.LoadChildrenAsync()

    Implements

    IHasChildren<T>
    IHasChildren
    System.IDisposable
    IEPCommandWithDescriptor
    IEPCommand
    System.Windows.Input.ICommand
    ICommandDescriptor

    Extension Methods

    MiscExtensions.SetIfNotEqual<T, P>(T, Expression<Func<T, P>>, P)
    ReflectionExtensions.ClearEventInvocations(Object, String)
    StringExtensions.ToCSVFormatString(Object, Type)
    SQLExtensions.ToSQLValue(Object, Boolean)
    CommandExtensions.CreateCommand(EPCommand, ICommandDescriptor, CommandButtonType, Boolean, CommandSize)
    CommandExtensions.UpdateCommand(EPCommand, Object, ICommandDescriptor, Boolean, CommandSize)
    In This Article
    Back to top © LemonTree Software Ltd. All rights reserved.