DirectOutput.General.FilePattern Class Reference

A file pattern class used to lookup files matching a specified pattern. More...

Inheritance diagram for DirectOutput.General.FilePattern:

Collaboration diagram for DirectOutput.General.FilePattern:

Public Member Functions
System.Xml.Schema.XmlSchema	GetSchema ()
	Method is required by the IXmlSerializable interface.
void	ReadXml (System.Xml.XmlReader reader)
	Deserializes the FilePattern in the XmlReader. ReadXml is part of the IXmlSerializable interface.
void	WriteXml (System.Xml.XmlWriter writer)
	Serializes the FilePattern to Xml. WriteXml is part of the IXmlSerializable interface.
string	ReplacePlaceholders (Dictionary< string, string > ReplaceValues=null)
	Returns the pattern with replaced placeholders.
List< FileInfo >	GetMatchingFiles (Dictionary< string, string > ReplaceValues=null)
	Gets the files matching the value of the property Pattern.
FileInfo	GetFirstMatchingFile (Dictionary< string, string > ReplaceValues=null)
	Gets the first file matching the value of the Pattern property.
	FilePattern (string Pattern)
	Initializes a new instance of the FilePattern class.
override string	ToString ()
	Returns a System.String that represents this instance.
	FilePattern ()
	Initializes a new instance of the FilePattern class.

Properties
string	Pattern [get, set]
	Gets or sets the pattern used to look for files.
bool?	IsValid [get]
	Gets a value indicating whether the Pattern is valid.

Events
PropertyChangedEventHandler	PropertyChanged
	Is fired if the value of a property changes.

Detailed Description

A file pattern class used to lookup files matching a specified pattern.

Constructor & Destructor Documentation

FilePattern() [1/2]

DirectOutput.General.FilePattern.FilePattern

(

string

Pattern

)

Initializes a new instance of the FilePattern class.

Parameters

Pattern

The file pattern.

FilePattern() [2/2]

DirectOutput.General.FilePattern.FilePattern

(

)

Initializes a new instance of the FilePattern class.

Member Function Documentation

GetFirstMatchingFile()

FileInfo DirectOutput.General.FilePattern.GetFirstMatchingFile

(

Dictionary< string, string >

ReplaceValues = null

)

Gets the first file matching the value of the Pattern property.

Parameters

ReplaceValues

Dictionary containing key/value pairs used to replace placeholders in the form {PlaceHolder} in the pattern.

Returns

The first file matching the value of the Pattern property or null if no file matches the pattern.

GetMatchingFiles()

List< FileInfo > DirectOutput.General.FilePattern.GetMatchingFiles

(

Dictionary< string, string >

ReplaceValues = null

)

Gets the files matching the value of the property Pattern.

Parameters

ReplaceValues

Dictionary containing key/value pairs used to replace placeholders in the form {PlaceHolder} in the pattern.

Returns

The list of files matching the value of the property Pattern or a empty list if no file matches the pattern.

GetSchema()

System.Xml.Schema.XmlSchema DirectOutput.General.FilePattern.GetSchema

(

)

Method is required by the IXmlSerializable interface.

Returns

Returns always null

ReadXml()

void DirectOutput.General.FilePattern.ReadXml

(

System.Xml.XmlReader

reader

)

Deserializes the FilePattern in the XmlReader.
ReadXml is part of the IXmlSerializable interface.

ReplacePlaceholders()

string DirectOutput.General.FilePattern.ReplacePlaceholders

(

Dictionary< string, string >

ReplaceValues = null

)

Returns the pattern with replaced placeholders.

Parameters

ReplaceValues

A dictionary containing the replace values.

Returns

Pattern with replaced placeholders.

ToString()

override string DirectOutput.General.FilePattern.ToString

(

)

Returns a System.String that represents this instance.

Returns

A System.String that represents this instance.

WriteXml()

void DirectOutput.General.FilePattern.WriteXml

(

System.Xml.XmlWriter

writer

)

Serializes the FilePattern to Xml.
WriteXml is part of the IXmlSerializable interface.

Property Documentation

IsValid

bool? DirectOutput.General.FilePattern.IsValid

get

Gets a value indicating whether the Pattern is valid.

true if the Pattern is valid; otherwise, false.

Pattern

string DirectOutput.General.FilePattern.Pattern

getset

Gets or sets the pattern used to look for files.

The pattern used to look for files.

Event Documentation

PropertyChanged

PropertyChangedEventHandler DirectOutput.General.FilePattern.PropertyChanged

Is fired if the value of a property changes.

---

The documentation for this class was generated from the following file:

• D:/a/DirectOutput/DirectOutput/DirectOutput/General/FilePattern.cs