wx.PackageBuilder.SrcNodeData Class Reference

Inheritance diagram for wx.PackageBuilder.SrcNodeData:

Inheritance graph

List of all members.

Public Member Functions

System.Xml.Schema.XmlSchema GetSchema ()
void NormalizeOriginalFileNames (string nameOfAValidDirOrFile)
void ReadXml (System.Xml.XmlReader reader)
 SrcNodeData (Build.ContentFile file, ICollection< Build.ContentType > types)
 SrcNodeData (Build.RefToProject project)
 SrcNodeData (Build.BuildProject project)
 SrcNodeData (Build.ContentFile file)
 SrcNodeData (KindOfSrcFolder folderType)
 SrcNodeData ()
void WriteXml (System.Xml.XmlWriter writer)

Static Public Member Functions

static string FolderTypeToString (KindOfSrcFolder value)

Public Attributes

Build.ContentFile File = null
KindOfSrcFolder FolderType = KindOfSrcFolder.NotOneOfTheSupportedFolders
NetFrameworkDescr NetFramework = null
PlatformDescr Platform = null
Build.RefToProject ProjectRef = null
ICollection
< Build.ContentType
Types = new List<Build.ContentType>()

Properties

Build.BuildProject Project [get]


Detailed Description

Class of data associated with tree nodes in the source tree. This contains a file of teh node represents a file and some additional information.

Constructor & Destructor Documentation

wx.PackageBuilder.SrcNodeData.SrcNodeData (  ) 

Creates empty data.

wx.PackageBuilder.SrcNodeData.SrcNodeData ( KindOfSrcFolder  folderType  ) 

Creates a tree node representing a certain kind of folder.

Parameters:
folderType Defines the kind of this node.

wx.PackageBuilder.SrcNodeData.SrcNodeData ( Build.ContentFile  file  ) 

Creates an instance referring to the provided file.

Parameters:
file 

wx.PackageBuilder.SrcNodeData.SrcNodeData ( Build.BuildProject  project  ) 

Call this to produce a node that is about a project.

Parameters:
project The project that shall be the data attached to this node.

wx.PackageBuilder.SrcNodeData.SrcNodeData ( Build.RefToProject  project  ) 

Call this to produce a node that is about a project.

Parameters:
project The project that shall be the data attached to this node.

wx.PackageBuilder.SrcNodeData.SrcNodeData ( Build.ContentFile  file,
ICollection< Build.ContentType types 
)

Creates an instance affecting the provided file (that must be a directory) and the provided content types.

Parameters:
file The descriptor of a directory
types The collection of those content types describing the files that shall be included into the project.


Member Function Documentation

static string wx.PackageBuilder.SrcNodeData.FolderTypeToString ( KindOfSrcFolder  value  )  [static]

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

Returns null as suggested by the framework docu.

void wx.PackageBuilder.SrcNodeData.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.SrcNodeData.ReadXml ( System.Xml.XmlReader  reader  ) 

Reads the date from the provided stream.

Parameters:
reader The XML stream
Exceptions:
System.FormatException Raised on illegal XML format.

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


Member Data Documentation

Build.ContentFile wx.PackageBuilder.SrcNodeData.File = null

This will be non-null iff this node refers to a file or directory.

KindOfSrcFolder wx.PackageBuilder.SrcNodeData.FolderType = KindOfSrcFolder.NotOneOfTheSupportedFolders

NetFrameworkDescr wx.PackageBuilder.SrcNodeData.NetFramework = null

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

PlatformDescr wx.PackageBuilder.SrcNodeData.Platform = null

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

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

This member will be set if this node contains a project.

ICollection<Build.ContentType> wx.PackageBuilder.SrcNodeData.Types = new List<Build.ContentType>()

If this refers to a directory, this slot will hold a collection of content types of files that are also part of the sources. If this also contains wx.Build.ContentType.Directory, all subdirs will be included into the relevant sources. If this is null although File is a directory, then the source tree has nt been expanded to refer also to contents of the directory.


Property Documentation

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

Read only access to the project of ProjectRef.


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