spiegel-keyman/web/docs/engine/reference/interface/contextExOutput.md
Marc Durdin 6c145cb775 refactor(web): move web engine help to app repo
Note: build.sh updated to make sure that test:help build action:target
doesn't also call test.sh by adding `:_all` meta-target.

Note: CI will need a new help-keyman-com.sh build step to deploy web
engine help.

Fixes: #12347
2024-10-31 11:00:06 +07:00

983 B

title
contextExOutput (KCXO)

Summary

contextExOutput function emits the character or object at contextOffset from the current matched rule's context. Introduced in Keyman 14.0, in order to resolve a gap between desktop and web core functionality for context(n) matching on notany().

Syntax

  keyman.interface.contextExOutput(dn, outputTarget, contextLength, contextOffset);

or

  KeymanWeb.KCXO(dn, outputTarget, contextLength, contextOffset); // Shorthand

Parameters

dn
Type: number
number of characters to delete left of cursor
outputTarget
Type: OutputTarget
target to output to
contextLength
Type: number
length of current rule context to retrieve
contextOffset
Type: number
offset from start of current rule context, 1-based

Returns

void

See also

History

  • Introduced in Keyman 14.0