TRODLUse

Overview

TRODLUse is a class that represents a reference to an existing RODL file.

Use Case

This class is used internally by TXMLToRODL to load RODL data into the TRODLLibrary. You may use this class to access RODL meta data (as described in the Manipulation of RODL Meta Data article).

Location

 

constructor Create  override

Creates a new instance with a unique GUID.

constructor Create

AbsoluteRodlFile

property AbsoluteRodlFile: string read write

Assign  override

Copies data from a given source.

procedure Assign(const Source: TRODLEntity)

Parameters:

  • Source: Instance whose properties will be copied

Attributes    (declared in TRODLEntity)

List of strings that represents object attributes.

property Attributes: TStrings read write

Data    (declared in TRODLEntity)

Object associated with the current TRODLEntity object. This property is needed to hold custom application-specific data at runtime for application coding convenience.

property Data: TObject read write

Documentation    (declared in TRODLEntity)

Description of the current object.

property Documentation: UnicodeString read write

DontCodegen    (declared in TRODLEntity)

property DontCodegen: boolean read write

GetDontCodegen  protected override

function GetDontCodegen: boolean

GroupUnder    (declared in TRODLEntity)

If the object is contained in group, this property returns the group object, otherwise it returns nil.

property GroupUnder: TRODLGroup read write

Includes

property Includes: TRODLIncludes read write

Info    (declared in TRODLEntity)

The TRODLEntity object that is associated with the current object. It is needed for backwards compatibility.

property Info: TRODLEntity read write

InUse    (declared in TRODLEntity)

property InUse: TRODLUseList read write

InUseCount    (declared in TRODLEntity)

property InUseCount: integer read write

IsFromUsedRodl    (declared in TRODLEntity)

Indicates when a class refers to the linked RODL file. The linked RODL file is declared in the section Uses of the current RODL file.

property IsFromUsedRodl: boolean read write

Items

Contains the collection of TRODLEntityList objects.

property Items: TRODLEntityList read write

LibDontCodegen

property LibDontCodegen: boolean read write

LoadedRodlLibraryGUID

property LoadedRodlLibraryGUID: TGUID read write

LoadedRodlLibraryName

property LoadedRodlLibraryName: string read write

LocatedInRodlUse    (declared in TRODLEntity)

Detailed info about the RODL that is using the current TRODLEntity object.

property LocatedInRodlUse: TRODLUse read write

Merged

property Merged: boolean read write

Name    (declared in TRODLEntity)

The Name of the current TRODLEntity object.

property Name: string read write

OriginalName    (declared in TRODLEntity)

The OriginalName of the current TRODLEntity object. If the private variable fOriginalName is not defined, OriginalName equals Name.

property OriginalName: string read write

Owner    (declared in TRODLEntity)

The Owner of the current TRODLEntity object.

property Owner: TRODLEntity read write

OwnerLibrary    (declared in TRODLEntity)

The owner library of the current object.

property OwnerLibrary: TRODLLibrary read write

ReadableEntityTypeName    (declared in TRODLEntity)

Returns the class name without the prefix 'TRODL'.

class function ReadableEntityTypeName: string

RodlFile

property RodlFile: string read write

SplitMode

property SplitMode: TRODLUseSplitMode read write

UID    (declared in TRODLEntity)

Unique identifier.

property UID: TGUID read write

Validate  override

Validates the current object.

procedure Validate(iMessages: IROPluginMessages)

Parameters:

  • iMessages: plugin

 

AbsoluteRodlFile

property AbsoluteRodlFile: string read write

Attributes    (declared in TRODLEntity)

List of strings that represents object attributes.

property Attributes: TStrings read write

Data    (declared in TRODLEntity)

Object associated with the current TRODLEntity object. This property is needed to hold custom application-specific data at runtime for application coding convenience.

property Data: TObject read write

Documentation    (declared in TRODLEntity)

Description of the current object.

property Documentation: UnicodeString read write

DontCodegen    (declared in TRODLEntity)

property DontCodegen: boolean read write

GroupUnder    (declared in TRODLEntity)

If the object is contained in group, this property returns the group object, otherwise it returns nil.

property GroupUnder: TRODLGroup read write

Includes

property Includes: TRODLIncludes read write

Info    (declared in TRODLEntity)

The TRODLEntity object that is associated with the current object. It is needed for backwards compatibility.

property Info: TRODLEntity read write

InUse    (declared in TRODLEntity)

property InUse: TRODLUseList read write

InUseCount    (declared in TRODLEntity)

property InUseCount: integer read write

IsFromUsedRodl    (declared in TRODLEntity)

Indicates when a class refers to the linked RODL file. The linked RODL file is declared in the section Uses of the current RODL file.

property IsFromUsedRodl: boolean read write

Items

Contains the collection of TRODLEntityList objects.

property Items: TRODLEntityList read write

LibDontCodegen

property LibDontCodegen: boolean read write

LoadedRodlLibraryGUID

property LoadedRodlLibraryGUID: TGUID read write

LoadedRodlLibraryName

property LoadedRodlLibraryName: string read write

LocatedInRodlUse    (declared in TRODLEntity)

Detailed info about the RODL that is using the current TRODLEntity object.

property LocatedInRodlUse: TRODLUse read write

Merged

property Merged: boolean read write

Name    (declared in TRODLEntity)

The Name of the current TRODLEntity object.

property Name: string read write

OriginalName    (declared in TRODLEntity)

The OriginalName of the current TRODLEntity object. If the private variable fOriginalName is not defined, OriginalName equals Name.

property OriginalName: string read write

Owner    (declared in TRODLEntity)

The Owner of the current TRODLEntity object.

property Owner: TRODLEntity read write

OwnerLibrary    (declared in TRODLEntity)

The owner library of the current object.

property OwnerLibrary: TRODLLibrary read write

RodlFile

property RodlFile: string read write

SplitMode

property SplitMode: TRODLUseSplitMode read write

UID    (declared in TRODLEntity)

Unique identifier.

property UID: TGUID read write

 

ReadableEntityTypeName    (declared in TRODLEntity)

Returns the class name without the prefix 'TRODL'.

class function ReadableEntityTypeName: string

 

constructor Create  override

Creates a new instance with a unique GUID.

constructor Create

Assign  override

Copies data from a given source.

procedure Assign(const Source: TRODLEntity)

Parameters:

  • Source: Instance whose properties will be copied

GetDontCodegen  protected override

function GetDontCodegen: boolean

Validate  override

Validates the current object.

procedure Validate(iMessages: IROPluginMessages)

Parameters:

  • iMessages: plugin