Plugin Hooks#
The following method hooks can be configured for your plugin via pluginInfo
.
Note: This documentation is a work in progress. Feel free to contribute documentation for any hooks missing documentation below. Please follow the existing documentation format, for example: FileSource.Exists.
Main Controller Processes#
Cntlr.Init
#
CntlrCmdLine.Filing.End
#
CntlrCmdLine.Filing.Start
#
CntlrCmdLine.Filing.Validate
#
CntlrCmdLine.Options
#
CntlrCmdLine.Utility.Run
#
CntlrCmdLine.Xbrl.Loaded
#
CntlrCmdLine.Xbrl.Run
#
Web Server#
CntlrWebMain.StartWebServer
#
GUI#
CntlrWinMain.Toolbar
#
CntlrWinMain.Xbrl.Loaded
#
CntlrWinMain.Xbrl.Open
#
DialogRssWatch.FileChoices
#
DialogRssWatch.ValidateChoices
#
Disclosure System#
DisclosureSystem.ConfigURL
#
DisclosureSystem.Types
#
Edgar Renderer#
EdgarRenderer.Filing.End
#
EdgarRenderer.Filing.Start
#
EdgarRenderer.Xbrl.Run
#
File System#
FileSource.Exists
#
This handle can be used to override FileSource
existence checks.
Example: A plugin that encrypts files, creating a copy with a different file extension, and the filepath should be transformed accordingly.
Arguments
cntlr: Cntlr
The controller the current request is running from.filepath: str
The path which Arelle is checking for the existence of a file.
Returns
bool | None
None
to defer to other plugins and/or default behavior.True
to indicate file exists.False
to indicate file does not exist.