Adaptive Console Framework - Build Your Console Application on the Fly

acqy

Rate me:

3.00/5 (1 vote)

18 Sep 2008CDDL9 min read

31K

286

Introduces the goal and use of the Adaptive Console Framework.

acf-52406.zip
- acfeditor
  - AcfEditor.Domain
    - AcfEditor.Domain.csproj
    - ApplicationContractSettings.cs
    - ApplicationProviderSettings.cs
    - bin
    - ContractOptionSettings.cs
    - ContractSetting.cs
    - EditorProject.cs
    - key.snk
    - obj
    - OptionSetting.cs
    - Properties
      - AssemblyInfo.cs
    - ReferencedAssembliesSettings.cs
  - acfeditor.sln
  - acfeditor
    - acfeditor.csproj
    - bin
    - frmEditor.cs
    - frmEditor.Designer.cs
    - frmEditor.resx
    - frmIntermediate.cs
    - frmIntermediate.Designer.cs
    - frmMain.cs
    - frmMain.Designer.cs
    - frmMain.resx
    - Handlers
    - Helper
      - TreeNodeValue.cs
    - obj
    - Program.cs
    - Properties
    - Resources
      - Control_TreeView.bmp
      - Delete.bmp
      - IMG_PROPERTY.bmp
      - NewDocument.bmp
      - OpenFolder.bmp
      - Properties.bmp
      - Save.bmp
      - SaveAll.bmp
  - icons
    - acf_project.ico
  - images
    - ApplicationProvider.bmp
    - Control_TreeView.bmp
    - Delete.bmp
    - EditCode.bmp
    - ErrorList.bmp
    - NewDocument.bmp
    - OpenFolder.bmp
    - Option.bmp
    - OptionContract.bmp
    - OptionContracts.bmp
    - Output.bmp
    - Project.bmp
    - Properties.bmp
    - ReferencedAssemblies.bmp
    - ReferencedAssembly.bmp
    - Save.bmp
    - SaveAll.bmp
    - Status.bmp
  - Referenced Assemblies
    - CSParser.dll
    - ICSharpCode.SharpZipLib.dll
    - SunnyChen.Common.dll
  - test
    - bin
    - obj
    - Program.cs
    - Properties
      - AssemblyInfo.cs
    - test.csproj
- AdaptiveConsole.sln
- AdaptiveConsole
  - AdaptiveConsole.csproj
  - AdaptiveConsole.csproj.user
  - AdaptiveConsoleException.cs
  - ArgumentInfo.cs
  - ArgumentMissingException.cs
  - bin
  - Config
    - AdaptiveConsoleConfigHandler.cs
    - RepositoryConfigElement.cs
    - RepositoryConfigElementCollection.cs
  - ConsoleApplicationBase.cs
  - ConsoleApplicationManager.cs
  - DesignModel
    - AttributeEventProvider.cs
    - PropertyChangedEventArgs.cs
  - help
    - classRef.shfb
    - output
      - clsref.chm
      - LastBuild.log
  - history.txt
  - images
    - doc.ico
    - help.ico
    - logo_sunnychen.gif
    - sln.ico
    - text.ico
    - Thumbs.db
  - InvalidContractException.cs
  - InvalidOptionException.cs
  - key.snk
  - obj
  - OptionAttribute.cs
  - OptionContractAttribute.cs
  - OptionContractBase.cs
  - OptionContractInfo.cs
  - Properties
    - AssemblyInfo.cs
- BuildProcessTemplates
  - DefaultTemplate.xaml
  - UpgradeTemplate.xaml
- catool
  - Catool.Contracts
    - bin
    - CalculationContract.cs
    - Catool.Contracts.csproj
    - DisplayVersionContract.cs
    - obj
    - Properties
      - AssemblyInfo.cs
  - Catool.Provider
    - bin
    - Catool.Provider.csproj
    - CatoolApplication.cs
    - obj
    - Properties
      - AssemblyInfo.cs
  - catool.sln
  - catool
    - App.config
    - bin
    - catool.csproj
    - obj
    - Program.cs
    - Properties
      - AssemblyInfo.cs
- docs
  - devman_enUS
    - Adaptive Console Framework Developer's Manual.wcp
    - Arguments and Options.htm
    - Contract Repository.htm
    - Contract Types.htm
    - Create the application provider.htm
    - Create the Console Application.htm
    - Create the option contracts.htm
    - devman.chm
    - Display Version Information.htm
    - Exact Contract Type.htm
    - Free Contract Type.htm
    - images
      - acf.gif
      - argument_categories.png
      - argument_property.png
      - asminfo.png
      - banner_helpbody.png
      - catool_add_reference.png
      - catool_add_reference_prj.png
      - catool_create_console_app.png
      - catool_create_contracts_prj.png
      - catool_new_project.png
      - catool_pw_1.png
      - catool_pw_2.png
      - catool_pw_3.png
      - catool_pw_4.png
      - catool_pw_5.png
      - contract_repository.png
    - None Contract Type.htm
    - Option Types.htm
    - OptionAttribute.htm
    - OptionContractAttribute.htm
    - Parameter Type.htm
    - Patternized Contract Type.htm
    - Perform Arithmetic Calculation.htm
    - Play With the catool Application.htm
    - Quick Start - catool Application.htm
    - SingleValue Option Type.htm
    - Switch Option Type.htm
    - Syntax and Option Contract.htm
    - Template Reference.htm
    - template
      - hgrad.gif
      - icon.gif
      - main.gif
      - msdn.htm
      - msn.htm
      - simplest.htm
      - standard.htm
      - top.gif
    - Templates.htm
    - The Application Configuration.htm
    - The Application Entry.htm
    - ValueList Option Type.htm
    - Welcome.htm
  - usrgde.doc
  - usrgde.mht
  - usrgde.pdf
- images
  - acf.gif
  - acf.psd
  - banner.bmp
  - banner.psd
- setup
  - acfsetup.ism
  - acfsetup
    - Script Files
      - Setup.dbg
      - Setup.inx
      - setup.isr
      - Setup.map
      - setup.obs
      - Setup.rul
    - String1033.txt
  - support
    - banner.bmp
    - externior.bmp
    - externior.jpg
    - externior.psd
    - license.rtf
AdaptiveConsoleSetup.zip
- AdaptiveConsoleSetup.msi
- setup.exe

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Help Screen Customization</title>
<meta name="GENERATOR" content="WinCHM">
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">

</head>

<BODY>
<P><FONT face=Verdana size=2>Developers can customize the help screen generated 
by ACF. In order to customize the banner and help body structure of the help 
screen, please override the <FONT face=Courier 
color=#800000>BannerTemplate</FONT> and <FONT face=Courier 
color=#800000>HelpBodyTemplate</FONT> abstract&nbsp;properties in your provider 
class. In order to customize the syntax line and the description for the option 
contract, please override the <FONT face=Courier color=#800000>Syntax</FONT> and 
<FONT face=Courier color=#800000>HelpText</FONT> abstract properties in the 
contract class.</FONT></P>
<P><FONT face=Verdana size=2>The help screen consist of two parts: Banner and 
HelpBody. The Banner is mainly for displaying the&nbsp;brief information of the 
application. By default, the Banner shows the following elements:</FONT></P>
<UL>
  <LI><FONT face=Verdana size=2>Application Logo (Returned by the overrided 
  <FONT face=Courier color=#800000>Logo</FONT> property in your provider 
  class)</FONT> 
  <LI><FONT face=Verdana size=2>Copyright Information (Defined on the <FONT 
  face=Courier color=#800000>AssemblyCopyright</FONT> property of the entry 
  assembly)</FONT> 
  <LI><FONT face=Verdana size=2>Application Description (Returned by the 
  override <FONT face=Courier color=#800000>Description</FONT> property in your 
  provider class)</FONT></LI></UL>
<P><FONT face=Verdana size=2>And the HelpBody shows the followings:</FONT></P>
<UL>
  <LI><FONT face=Verdana size=2>Syntax line for each option contract 
  (syntax)</FONT> 
  <LI><FONT face=Verdana size=2>Syntax description for each syntax 
  line</FONT></LI></UL>
<P><FONT face=Verdana size=2>For example, the catool application gives the 
following help screen, which is generated by using the default 
format.</FONT></P>
<P><FONT face=Verdana size=2><IMG alt="" src="images/banner_helpbody.png"></FONT></P>
<P><FONT face=Verdana size=2>You can use templates in the <FONT face=Courier 
color=#800000>BannerTemplate</FONT> and <FONT face=Courier 
color=#800000>HelpBodyTemplate</FONT> properties to define your customized help 
screen. You cannot use templates in the <FONT face=Courier 
color=#800000>Syntax</FONT> and <FONT color=#800000>HelpText</FONT> properties, 
however, the <FONT face=Courier color=#800000>Attribute</FONT> and <FONT 
face=Courier color=#800000>OptionAttributes</FONT> protected member in your 
contract class may help you to get the required information while you are going 
to generate your customized syntax lines and syntax description.</FONT></P>
<P><FONT face=Verdana size=2>For more information about templates, please refer 
to the <A href="Template Reference.htm">Template 
Reference</A>.</FONT></P></BODY>
</html>

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Common Development and Distribution License (CDDL)

Written By

acqy

Architect Prosource Development

China

I have more than 13 years' experience in software development and more than 5 years' working experience in software industry. I'm the National Certified System Analyst and now I'm the consultant of China System Analyst Institution. I also got the MCP/MCAD certificate on .NET technology in the year 2004.
I'm very interested in system architect and analysis, and also interested in .NET technologies. For my blog please refer to http://www.sunnychen.org.

Adaptive Console Framework - Build Your Console Application on the Fly

License

Comments and Discussions