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

<Type Name="FileDialog" FullName="Terminal.Gui.FileDialog">
  <TypeSignature Language="C#" Value="public class FileDialog : Terminal.Gui.Dialog" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FileDialog extends Terminal.Gui.Dialog" />
  <AssemblyInfo>
    <AssemblyName>Terminal.Gui</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Terminal.Gui.Dialog</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Base class for the OpenDialog and the SaveDialog
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FileDialog (NStack.ustring title, NStack.ustring prompt, NStack.ustring nameFieldLabel, NStack.ustring message);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class NStack.ustring title, class NStack.ustring prompt, class NStack.ustring nameFieldLabel, class NStack.ustring message) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="title" Type="NStack.ustring" />
        <Parameter Name="prompt" Type="NStack.ustring" />
        <Parameter Name="nameFieldLabel" Type="NStack.ustring" />
        <Parameter Name="message" Type="NStack.ustring" />
      </Parameters>
      <Docs>
        <param name="title">To be added.</param>
        <param name="prompt">To be added.</param>
        <param name="nameFieldLabel">To be added.</param>
        <param name="message">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AllowedFileTypes">
      <MemberSignature Language="C#" Value="public string[] AllowedFileTypes { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string[] AllowedFileTypes" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String[]</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The array of filename extensions allowed, or null if all file extensions are allowed.
            </summary>
        <value>The allowed file types.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AllowsOtherFileTypes">
      <MemberSignature Language="C#" Value="public bool AllowsOtherFileTypes { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool AllowsOtherFileTypes" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a value indicating whether this <see cref="T:Terminal.Gui.FileDialog" /> allows the file to be saved with a different extension
            </summary>
        <value>
          <c>true</c> if allows other file types; otherwise, <c>false</c>.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CanCreateDirectories">
      <MemberSignature Language="C#" Value="public bool CanCreateDirectories { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool CanCreateDirectories" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a value indicating whether this <see cref="T:Terminal.Gui.FileDialog" /> can create directories.
            </summary>
        <value>
          <c>true</c> if can create directories; otherwise, <c>false</c>.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DirectoryPath">
      <MemberSignature Language="C#" Value="public NStack.ustring DirectoryPath { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class NStack.ustring DirectoryPath" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>NStack.ustring</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the directory path for this panel
            </summary>
        <value>The directory path.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FilePath">
      <MemberSignature Language="C#" Value="public NStack.ustring FilePath { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class NStack.ustring FilePath" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>NStack.ustring</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The File path that is currently shown on the panel
            </summary>
        <value>The absolute file path for the file path entered.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsExtensionHidden">
      <MemberSignature Language="C#" Value="public bool IsExtensionHidden { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool IsExtensionHidden" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a value indicating whether this <see cref="T:Terminal.Gui.FileDialog" /> is extension hidden.
            </summary>
        <value>
          <c>true</c> if is extension hidden; otherwise, <c>false</c>.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Message">
      <MemberSignature Language="C#" Value="public NStack.ustring Message { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class NStack.ustring Message" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>NStack.ustring</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the message displayed to the user, defaults to nothing
            </summary>
        <value>The message.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="NameFieldLabel">
      <MemberSignature Language="C#" Value="public NStack.ustring NameFieldLabel { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class NStack.ustring NameFieldLabel" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>NStack.ustring</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the name field label.
            </summary>
        <value>The name field label.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Prompt">
      <MemberSignature Language="C#" Value="public NStack.ustring Prompt { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class NStack.ustring Prompt" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>NStack.ustring</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the prompt label for the button displayed to the user
            </summary>
        <value>The prompt.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="WillPresent">
      <MemberSignature Language="C#" Value="public override void WillPresent ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void WillPresent() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>