ArchSettingActionPropertyDefault(archDefinitionAction, propertyName, propertyDefaultValue)

new ArchSettingActionPropertyDefault(archDefinitionAction, propertyName, propertyDefaultValue)

The Architect Scripting base class for an action property default value. Note: Do not attempt to create instances of this class directly. They will be created automatically as needed by Architect Scripting.

Parameters:
Name Type Description
archDefinitionAction ArchDefinitionAction

the definition of the containing action for this default
propertyName string

the name of property on the action to which this default applies
propertyDefaultValue ArchBaseValue

the default value to use for the property

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchSettingActionPropertyDefault'.

readonly ArchSettingActionPropertyDefault :boolean

Returns true indicating that this is an ArchSettingActionPropertyDefault instance.

readonly definitionAction :ArchDefinitionAction

Returns the action definition for this property default.

readonly displayTypeName :string

Returns a display string that reflects the type for this Architect Scripting object.

Overrides:

readonly logStr :string

A string suitable for logging that contains information about this definition.

Overrides:

readonly logStrTypeOnly :string

This is a string suitable for logging information about this object where it's just the object's type. This is normally used when logging errors that occur in constructor parameter checking because the scripting object isn't set up and the normal logging str contents wouldn't be set up.

Inherited From:

readonly propertyDefaultValue :ArchBaseValue

Returns the default value for the property.

readonly propertyName :string

Returns the name of the property on the object for which this is the default.

Methods

isFilterMatch(archFilterObject) → {boolean}

Returns whether or not this Architect Scripting object is a match for the supplied ArchFilterObject instance.

Parameters:
Name Type Description
archFilterObject ArchFilterObject

the object filter to use to determine if it's a match.
Returns:
boolean
Inherited From:

logError(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true.

Parameters:
Name Type Description
errorStr string

the error string to log.
Inherited From:

logErrorAndThrow(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true and then throws the string in the errorStr parameter.

Parameters:
Name Type Description
errorStr string

the error string to log. This should be a non-blank string.
Throws:
  • Throws the submitted error string.
Inherited From:

logNote(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotes is true.

Parameters:
Name Type Description
noteStr string

the note string to log. This should be a non-blank string.
Inherited From:

logNoteVerbose(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotesVerbose is true.

Parameters:
Name Type Description
noteStr string

the note string to log. This should be a non-blank string.
Inherited From:

logWarning(warningStr)

Logs a warning to the logging service with a log header from this object's logStr property value when ArchLogging#logWarnings is true.

Parameters:
Name Type Description
warningStr string

the warning string to log. This should be a non-blank string.
Inherited From: