Skip to main content

List

function List: TStringList;

Example​

procedure ScriptEvent(var Value: variant);
begin
  List.Clear;
  List.Add('Example');
  Value := List.Text;
end;

Usage​

Use List as a reusable TStringList workspace for building, sorting or searching a list of strings. Clear it before starting unrelated work and copy out values that must remain unchanged after later scripts run. Do not free it.

List and Text are separate workspaces in current Velox; changing one does not change the other.

Changes to List remain available to later scripts in the same execution. Reading List alone does not load or save any data.

Additional Technical Info​

List is a no-argument Velox scripting helper that returns a live object. It does not copy the object or make the returned reference private to the calling statement.

PropertyDetail
Return typeTStringList
OwnershipScripter-owned
Creation/accessGetter call; see lifecycle below
Thread safetyMutable and not safe for concurrent/asynchronous use

Identity, creation and lifetime

The getter lazily creates TvxScripter.FList, returns that instance on later calls and frees it with the scripter.

Failures, safety and implementation cautions

The list is mutable state local to the scripter, not an action-wide cache. Clear it before reuse, account for newline/name-value/duplicate/sorted-list semantics when using inherited operations, and do not free or expose it to asynchronous work.

Class methods can raise on invalid state, parsing/conversion failures, I/O errors or invalid arguments unless their own contract documents a different result. Copy required scalar results before another script or operation can replace mutable state.

Related entry

  • TStringList documents the returned class and its exposed methods/properties.
  • Helpers compares lifetime, sharing and context rules for all helper objects.

External references

Created 2026-07-15