gui-cs.Terminal.Gui/ecmadocs/en/Terminal.Gui/MenuItem.xml

<Type Name="MenuItem" FullName="Terminal.Gui.MenuItem">
  <TypeSignature Language="C#" Value="public class MenuItem" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MenuItem extends System.Object" />
  <AssemblyInfo>
    <AssemblyName>Terminal.Gui</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            A menu item has a title, an associated help text, and an action to execute on activation.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public MenuItem (NStack.ustring title, string help, Action action);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class NStack.ustring title, string help, class System.Action action) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="title" Type="NStack.ustring" />
        <Parameter Name="help" Type="System.String" />
        <Parameter Name="action" Type="System.Action" />
      </Parameters>
      <Docs>
        <param name="title">Title for the menu item.</param>
        <param name="help">Help text to display.</param>
        <param name="action">Action to invoke when the menu item is activated.</param>
        <summary>
            Initializes a new <see cref="T:Terminal.Gui.MenuItem" />.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Action">
      <MemberSignature Language="C#" Value="public Action Action { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Action Action" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Action</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the action to be invoked when the menu is triggered
            </summary>
        <value>Method to invoke.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Help">
      <MemberSignature Language="C#" Value="public NStack.ustring Help { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class NStack.ustring Help" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>NStack.ustring</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the help text for the menu item.
            </summary>
        <value>The help text.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="HotKey">
      <MemberSignature Language="C#" Value="public Rune HotKey;" />
      <MemberSignature Language="ILAsm" Value=".field public valuetype System.Rune HotKey" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Rune</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The hotkey is used when the menu is active, the shortcut can be triggered when the menu is not active.   
            For example HotKey would be "N" when the File Menu is open (assuming there is a "_New" entry
            if the ShortCut is set to "Control-N", this would be a global hotkey that would trigger as well
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ShortCut">
      <MemberSignature Language="C#" Value="public Terminal.Gui.Key ShortCut;" />
      <MemberSignature Language="ILAsm" Value=".field public valuetype Terminal.Gui.Key ShortCut" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Key</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            This is the global setting that can be used as a global shortcut to invoke the action on the menu.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Title">
      <MemberSignature Language="C#" Value="public NStack.ustring Title { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class NStack.ustring Title" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>NStack.ustring</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the title.
            </summary>
        <value>The title.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>