Class ecStyleCheckRun

Properties

LOCAL lbSepChar$=$09$  
PROPERTY hasSecondaryRuleFile   * Read Only *

A boolean to identify when there is a secondary rules file in the contributed tools folder

Methods

FUNCTION getRules$()  

Get the rules loaded from the specifed rules file

Returns A string containing the rules that were loaded
FUNCTION getSecondaryRuleFilePath$()  

Get the full path to the secondary rules file

Returns the full path to the secondary rules file
FUNCTION GetStyleCheckName$()  

Get the name for the style check class

Returns The name of the class
FUNCTION loadRules(theRuleFile$)  

Load the style rules from properies file; will load from a file in the same location as primary class; and then append any rules found in secondary file in Contributed tools folder

ParameterDescription
theRuleFile$ The name of the properties file ti be loaded
FUNCTION ProcessFile(theFile$, resetMarks, updateOK)  
FUNCTION ProcessFile(theFile$, resetMarks, updateOK, theStatus$)  
FUNCTION ProcessFile(theFile$, resetMarks, updateOK, theStatus$, isPvxClass, retSrcFile$)  

Process the selected (or current) source file against the style rules and update the problem view with any errors or warnings that are generated.

ParameterDescription
theFile$ The name of the source file to be processed against the style rules
resetMarks A boolean flag to indicate whether the current problem view information for this file should be reset before applying the information created by the style check
updateOK A boolean flag to identify if the source file can be updated as a result of processing the style rules
theStatus$ (Optional) A string containing the results of the style check (Errors/Warnings)
isPvxClass (Optional) A boolean flag to indicate if currect file is a ProvideX Class
retSrcFile$ (Optional) Name of new source file created if option set to replace tags
FUNCTION ProcessNavViewSelections()  

Process the selected (or current) source file against the style rules and update the problem view with any errors or warnings that are generated.

Properties inherited from: com.pvx.util.progress

theCaption$,theDescription$, screen_id$, screen_lib$

Methods inherited from: com.pvx.util.progress

checkCancel(), createLogFile(), disable_cancel(), enable_cancel(), enable_special(), writeLog(), writeLogFile(), b_close(), b_special(), disable_special(), doWork(), onExit(), PostLoad(), PreLoad(), setDescription(), updateView(), workDone()