Resource processor to automatically export messages in given list of domains to a particular file after compilation. More...

Inheritance diagram for LocalizationExport:

Public Member Functions
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

_.Library.String	GetDomainsForResource ()
	Returns a comma-separated list of domains for the specified resource.

Public Member Functions inherited from Abstract
	OnGetStudioProject (_.Studio.Project pProject, _.Library.Boolean pHandled)
	Subclasses may override to customize the studio project. More...

	OnGetUniqueName (pUniqueName)
	Returns a unique name for this resource. More...

_.Library.String	OnItemRelativePath (_.Library.String pItemName)
	Returns the path relative to the module root for item pItemName within this resource.

_.Library.Status	OnPhase (_.Library.String pPhase, pParams, _.Library.Boolean pResourceHandled)
	Called as phase pPhase is executed for the resource. More...

Static Public Member Functions
_.Library.Status	GetMessageFile (_.Library.String pDocName, _.IPM.ResourceProcessor.LocalizationExport.MsgFile pFileObject)
	pDocName is the full document name (including the .LOC extension) More...

_.Library.Status	SaveMessageFile (_.Library.String pDocName, _.IPM.ResourceProcessor.LocalizationExport.MsgFile pFileObject, _.Library.Boolean pCompile, pConsoleOutput)
	pDocName is the full document name (including the .LOC extension) More...

Public Attributes
	Domains
	Comma-separated list of domains to export to the specified file. More...

	Filename
	Filename to export to. More...

Public Attributes inherited from Abstract
	Params
	More...

Static Public Attributes
	ATTRIBUTES = None
	Comma-separated list of resource attribute names that this processor uses.

	DESCRIPTION = None
	Description of resource processor class (shown in UI)

Static Public Attributes inherited from Abstract
	ATTRIBUTES = None
	Comma-separated list of resource attribute names that this processor uses.

	DESCRIPTION = None
	Description of resource processor class (shown in UI)

Static Private Member Functions
_.Library.Status	__Export (_.Library.String pDocName, _.IPM.ResourceProcessor.LocalizationExport.MsgFile pSource, pSourceControlOutput)
	Utility method to export an error message document (with a given name).

Detailed Description

Resource processor to automatically export messages in given list of domains to a particular file after compilation.

This works with a resource like /localize/MessageFileName.xml (Domains attribute required; resource name used as export target), or MyPackage.Errors.LOC (Filename attribute required; Domains populated automatically from the message file) For .LOC resources, the default resource processor class (IPM.ResourceProcessor.Default.LocalizedMessages) should be used instead.

Member Function Documentation

◆ OnValidateObject()

_.Library.Status OnValidateObject ( )

This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to.

provide notification that the current object is being validated.

If this method returns an error then <METHOD>ValidateObject</METHOD> will fail.

◆ GetMessageFile()

_.Library.Status GetMessageFile	(	_.Library.String	pDocName,
		_.IPM.ResourceProcessor.LocalizationExport.MsgFile	pFileObject
	)

static

pDocName is the full document name (including the .LOC extension)

pFileObject is an instance of IPM.ResourceProcessor.LocalizationExport.MsgFile corresponding to the document's content.
@API.Method @Modifier Availability InterSystems

◆ SaveMessageFile()

_.Library.Status SaveMessageFile	(	_.Library.String	pDocName,
		_.IPM.ResourceProcessor.LocalizationExport.MsgFile	pFileObject,
		_.Library.Boolean	pCompile,
			pConsoleOutput
	)

static

pDocName is the full document name (including the .LOC extension)

pFileObject is an instance of IPM.ResourceProcessor.LocalizationExport.MsgFile corresponding to the document's content.
If pCompile is set to 1 (by default, it is), then the file will be compiled after save.
pConsoleOutput is an integer-subscripted array of lines of output from everything that happened.
@API.Method @Modifier Availability InterSystems

Member Data Documentation

◆ Domains

Domains

Comma-separated list of domains to export to the specified file.

For .LOC documents, this is determined automatically and is not overridable.

◆ Filename

Filename

Filename to export to.

For .LOC documents, this is required; otherwise, this is set to the resource name and is not overridable.

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Static Private Member Functions