Interface IDelphiProjectEditor

File editor interface for Delphi type projects

Inherited Members

IXMLEditor.Save()

Namespace: IdeProjectFileEditor

Assembly: BuildSystem.Utils.dll

Syntax

public interface IDelphiProjectEditor : IXMLEditor

Properties

MainSrcEditor

Returns the main source (.dpr/.dpk) file editor.

Declaration

IDelphiMainSrcEditor MainSrcEditor { get; }

Property Value

Type	Description
IDelphiMainSrcEditor

MainSrcFile

Returns the "MainSource" attribute value: the relative path of the source project file with the ".dpr/.dpk" extension.

Declaration

string MainSrcFile { get; }

Property Value

Type	Description
string

ProjAppType

Returns the "AppType" attribute value. Expected values: "Application", "Package", "Library"

Declaration

string ProjAppType { get; }

Property Value

Type	Description
string

SupportedPlatform

Returns the project's supported platforms.

Declaration

DPlatformType SupportedPlatform { get; }

Property Value

Type	Description
DPlatformType

Methods

AddXElement(DConfigType, DPlatformType, string, string)

Adding a new XML element to the project file.

Declaration

void AddXElement(DConfigType configuration, DPlatformType platform, string elName, string elValue)

Parameters

Type	Name	Description
DConfigType	configuration	Applicable configuration
DPlatformType	platform	Applicable platform
string	elName	XML element name (the name of the tag)
string	elValue	XML element value (the value of the given tag)

ClearAllPaths()

Clears all setted paths with the DPathPropType enum (including search paths) in the project file

Declaration

void ClearAllPaths()

ClearAllPaths(DConfigType, DPlatformType)

Clears all configured paths with the DPathPropType enum (including search paths) in the project file

Declaration

void ClearAllPaths(DConfigType configuration, DPlatformType platform)

Parameters

Type	Name	Description
DConfigType	configuration
DPlatformType	platform

GenerateXMLDocs(DConfigType, DPlatformType)

Returns true if the project generates XML documentations. Otherwise, returns false.

Declaration

bool GenerateXMLDocs(DConfigType configuration, DPlatformType platform)

Parameters

Type	Name	Description
DConfigType	configuration
DPlatformType	platform

Returns

Type	Description
bool

GetDCCReferences()

Returns relative paths for required project references and source files. Information may not be accurate.

Declaration

string[] GetDCCReferences()

Returns

Type	Description
string[]

GetPath(DConfigType, DPlatformType, DPathPropType)

Returns the configured path

Declaration

string GetPath(DConfigType configuration, DPlatformType platform, DPathPropType type)

Parameters

Type	Name	Description
DConfigType	configuration
DPlatformType	platform
DPathPropType	type

Returns

Type	Description
string

GetSearchPaths(DConfigType, DPlatformType)

Returns the project search paths

Declaration

string[] GetSearchPaths(DConfigType configuration, DPlatformType platform)

Parameters

Type	Name	Description
DConfigType	configuration
DPlatformType	platform

Returns

Type	Description
string[]

GetXMLDocsOutput(DConfigType, DPlatformType)

Returns the output path value of the project's XML documentation (DCC_XmlOutput)

Declaration

string GetXMLDocsOutput(DConfigType configuration, DPlatformType platform)

Parameters

Type	Name	Description
DConfigType	configuration
DPlatformType	platform

Returns

Type	Description
string

HasBinary(DBinOutType, DConfigType, DPlatformType)

Returns true if the project generates specified binary file according to the specified configuration. Otherwise, returns false.

Declaration

bool HasBinary(DBinOutType binaryType, DConfigType configuration, DPlatformType platform)

Parameters

Type	Name	Description
DBinOutType	binaryType
DConfigType	configuration
DPlatformType	platform

Returns

Type	Description
bool

SetPath(DConfigType, DPlatformType, DPathPropType, string)

Sets the configured path

Declaration

void SetPath(DConfigType configuration, DPlatformType platform, DPathPropType type, string path)

Parameters

Type	Name	Description
DConfigType	configuration
DPlatformType	platform
DPathPropType	type
string	path

SetSearchPaths(DConfigType, DPlatformType, string[])

Sets the project search paths

Declaration

void SetSearchPaths(DConfigType configuration, DPlatformType platform, string[] paths)

Parameters

Type	Name	Description
DConfigType	configuration
DPlatformType	platform
string[]	paths