开源代码生成器MyGeneration使用(三) 重要API和指令介绍

我们先看看Template Code的父类代码:
public abstract class _DotNetScriptTemplate
{
	protected ZeusTemplateContext context;
	protected ZeusInput input;
	protected ZeusOutput output;
	protected Hashtable objects;

	public _DotNetScriptTemplate(ZeusTemplateContext context)
	{
		this.input = context.Input;
		this.objects = context.Objects;
		this.output = context.Output;
	}

	public abstract void Render();
}

public abstract class DotNetScriptTemplate : _DotNetScriptTemplate
{
	protected Zeus.UserInterface.GuiController ui;
	protected MyMeta.dbRoot MyMeta;
	protected Dnp.Utils.Utils DnpUtils;
	public DotNetScriptTemplate(IZeusContext context) : base(context)
	{
		this.ui = context.Objects["ui"] as Zeus.UserInterface.GuiController;
		this.MyMeta = context.Objects["MyMeta"] as MyMeta.dbRoot;
		this.DnpUtils = context.Objects["DnpUtils"] as Dnp.Utils.Utils;
	}
}

上面两个类的可继承变量可以说是整个模板编写的基础。以下是重要API的介绍:

MyMeta Namespace:

dbRoot类属性 public IDatabases Databases{get;} //取得数据库集合
dbRoot类属性 public IDatabase DefaultDatabase{get;} //缺省数据库,也就是在连接字符串中定义的数据库
IDatabase接口,数据库的抽象。其中重要的属性有Name(数据库名),Alias(别名),Tables(数据库内表集合),Views(数据库内视图集合)
ITable接口,数据表的抽象。重要属性有Name(表名),Alias(别名),Columns(数据列集合),ForeignKeys(外键集合),PrimaryKeys(主键集合),Indexes(索引集合),Database(所在数据库)
IColumn接口,数据列抽象。列的属性字段都比较重要

Zeus Namespace:(注Zeus是在PluginInterfaces.dll这个程序集里)

ZenusInput类,是一个类似hashtable的数据窗口,主要用于获取用户界面输入。如获取控件TextBox的值input["textBoxID"],这里的input定义在_DotNetScriptTemplate类中protected ZeusInput input;
   同时还存储了一些应用程序变量如input["defaultOutputPath"]缺省输出路径,其他请请看API。
ZeusOutput类,是一个输出缓存区,所有的不在<%%>内的字符,write()方法都是输出到这个缓存区。重要方法:
  write(String str)    输出字符串,writeln(String str)输出字符串并换行;
  autoTab(String str)   输出字符串前面自动加上制表符tab,该tab个数由属性tabLevel决定。autoTabLn(String str) ;
  save(String path,Object action)   保存缓存区里的内容到文件,参数action可选值有 "d"如果文件不存在则保存,“o”保存文件如果已存在则覆盖

   ,“b”保存文件如果已存在则备份后再覆盖,“a”保存文件如果已存在则追加到文件;
  saveEnc(String path,Object action,Object encoding)   同上方法,只是多加了个编码参数;
  append(String path)   相当于save(String path,"a");
  clear()   清除缓存区里的内容;

ZeusOutpu类只有两个属性,tabLevel表示当前制表符的个数, output.tabLevel++即制表符加一,text设置或者取得缓存区的字符串。

Zeus.UserInterface Namespace:

该命令空间内封装了基础的winform控件,如GuiButton,GuiCheckBox,GuiTextBox等。这里不一一介绍了。
GuiControlller类,定义了一系统添加控件的方法,如AddButton,AddTextBox等。

了解了这些API,再去看上面两个类代码,能更深入的了解模板的编写。

我们再来看看MyGeneration指令吧

<%#FILE codeInclude.cs%>    包含指令;
<%#REFERENCE MyCustomAssembly.dll,System.Windows.Forms.dll%>    引用指令,就是要引用的程序集dll文件,dll文件可以是与Mygeneration.exe在一个目录或者放在GAC里;
<%#NAMESPACE System.IO,System.Text%>    引入命名空间,也就是C#里的using了;
<%#DEBUG%>    调试指令,放在模板的第一行而且必须是<%#DEBUG%><%
  这样的不能有空格,再在Render方法里调用System.Diagnostics.Debugger.Launch()

你可能感兴趣的:(api,MyGeneration,MyGeneration使用,MyGeneration教程,MyGeneration指令)