wx.PackageBuilder.TocNodeData Class Reference

Inheritance diagram for wx.PackageBuilder.TocNodeData:

Inheritance graph

List of all members.

Public Member Functions

System.Xml.Schema.XmlSchema GetSchema ()
void NormalizeOriginalFileNames (string nameOfAValidDirOrFile)
void ReadXml (System.Xml.XmlReader reader)
void SetResourceName (string basenname, int index)
string StringForResource (string resourceName)
 TocNodeData (int srcNode, TreeOfContentFiles< SrcNodeData, SrcLeafData > srcTree)
 TocNodeData (string featurename)
 TocNodeData ()
override string ToString ()
void WriteXml (System.Xml.XmlWriter writer)

Public Attributes

CompressionMode Compression = CompressionMode.GZip
string FeatureName = null
string NameInRes = null
NetFrameworkDescr NetFramework = null
PlatformDescr Platform = null
Build.RefToProject ProjectRef = null
int SrcNode = -1
TreeOfContentFiles
< SrcNodeData,
SrcLeafData
SrcTree = null

Properties

Build.ContentFile File [get]
Build.BuildProject Project [get]
SrcLeafData SrcLeafData [get]
SrcNodeData SrcNodeData [get]


Detailed Description

Data class for nodes in the TOC representing those files that can actually be installed.

Constructor & Destructor Documentation

wx.PackageBuilder.TocNodeData.TocNodeData (  ) 

Use this when reading from XML stream.

wx.PackageBuilder.TocNodeData.TocNodeData ( string  featurename  ) 

Creates an instance representing a feature.

Parameters:
featurename The name of the represented feature.

wx.PackageBuilder.TocNodeData.TocNodeData ( int  srcNode,
TreeOfContentFiles< SrcNodeData, SrcLeafData srcTree 
)

Creates an instance referring to a file. Please note, that this will not guarantee that the resource name is unique.

Parameters:
srcNode The ID of the node in the source tree.
srcTree The instance of the data associated with the source file tree.


Member Function Documentation

System.Xml.Schema.XmlSchema wx.PackageBuilder.TocNodeData.GetSchema (  ) 

Returns null as suggested by the framework documentation.

Returns:

void wx.PackageBuilder.TocNodeData.NormalizeOriginalFileNames ( string  nameOfAValidDirOrFile  ) 

You may use this method to control the form of the file name that will be used to serialize this (the original filename). The argument is a path to an existing file or directory. This will strip a directory information from this path. After that, the original file name will change to something equivalent to the absolute filename (referring to the same file) but now relative to the directory as specified by the argument.

Use this method to prepare content file instance for serialization in such a way that all file names become relative to the same directory.

Parameters:
nameOfAValidDirOrFile The name of an existing file or directory. This name will - if relative - be expanded using the BuildConfig.
See also:
OriginalFileName

Exceptions:
System.ArgumentException Will be raised if the argument is neither the path to an existing file nor directory.

Implements wx.PackageBuilder.IDataReferringToFiles.

void wx.PackageBuilder.TocNodeData.ReadXml ( System.Xml.XmlReader  reader  ) 

void wx.PackageBuilder.TocNodeData.SetResourceName ( string  basenname,
int  index 
)

Support to set unique resource names.

Parameters:
basenname basename of the resource
index an index to produce a unique name extending the base name. shall be larger than or equal to 0.

string wx.PackageBuilder.TocNodeData.StringForResource ( string  resourceName  ) 

Returns a string equivalent to the result of the ToString() method on a resource of the name provided to this method.

Parameters:
resourceName The resource name that will appear in the resulting string.
Returns:

override string wx.PackageBuilder.TocNodeData.ToString (  ) 

String representation indicating either feature or resource name.

void wx.PackageBuilder.TocNodeData.WriteXml ( System.Xml.XmlWriter  writer  ) 

Creates either a "pkg-content" element or a "pkg-feature" element.

Parameters:
writer The destination of the serialization.


Member Data Documentation

CompressionMode wx.PackageBuilder.TocNodeData.Compression = CompressionMode.GZip

string wx.PackageBuilder.TocNodeData.FeatureName = null

This is the name of a feature. This is null if this data represents a resource file and not a feature.

string wx.PackageBuilder.TocNodeData.NameInRes = null

The name of the file in the resource stream. This is null if this represents a feature and not a resource.

NetFrameworkDescr wx.PackageBuilder.TocNodeData.NetFramework = null

The .NET version, that has been used to build the file.

PlatformDescr wx.PackageBuilder.TocNodeData.Platform = null

The platform, that has been used to build the file.

Build.RefToProject wx.PackageBuilder.TocNodeData.ProjectRef = null

Reference to a project if this node represents a project.

int wx.PackageBuilder.TocNodeData.SrcNode = -1

This is the id of the corresponding node in the source tree. If this node has not been derived from a source file, this is -1.

TreeOfContentFiles<SrcNodeData, SrcLeafData> wx.PackageBuilder.TocNodeData.SrcTree = null

The source tree. necessary to infer the node designated by SrcNode.


Property Documentation

Build.ContentFile wx.PackageBuilder.TocNodeData.File [get]

Returns a description of the source file that refers to this content of the package. This will be null if this does not refer to a file, e.g. if this is a feature of the package.

Build.BuildProject wx.PackageBuilder.TocNodeData.Project [get]

The project that refers to this node if such a project exists. null otherwise.

ProjectRef

SrcLeafData wx.PackageBuilder.TocNodeData.SrcLeafData [get]

If this refers to a leaf node in the tree of source files, this is the instance of the data associated with that node. This will be null if this does not refer to a leaf node.

SrcNodeData wx.PackageBuilder.TocNodeData.SrcNodeData [get]

If this refers to a non-leaf node in the tree of source files, this is the instance of the data associated with that node. This will be null if this does not refer to a leaf node.


The wx.NET Build System.   (c) 2009-2010 Harald Meyer auf'm Hofe