API Reference
Class
LogEventArgs
Event data for engine log messages (progress fields and formatted message).
Inheritance
- EventArgs
- LogEventArgs
Constructors
LogEventArgs 3 overloads
public LogEventArgs(String message, Object[] args) #Creates a log event for a formatted message with arguments.
Parameters
- message System.String
- Message template compatible with [[cref:System.String.Format(System.String,System.Object[])]].
- args System.Object[]
- Arguments to substitute into the template.
public LogEventArgs(String message) #Creates a log event for a plain message without arguments.
Parameters
- message System.String
- Message text.
public LogEventArgs(String activity, String currentOperation, Nullable<Int32> currentSteps, Nullable<Int32> totalSteps, Nullable<Int32> percentage) #Creates a progress log event.
Parameters
- activity System.String
- Top-level activity label.
- currentOperation System.String
- Current operation within the activity.
- currentSteps System.Nullable{System.Int32}
- Current step count.
- totalSteps System.Nullable{System.Int32}
- Total step count.
- percentage System.Nullable{System.Int32}
- Completion percentage.
Inherited Methods
Properties
public Nullable<Int32> ProgressPercentage { get; set; } #Progress percentage
public Nullable<Int32> ProgressTotalSteps { get; set; } #Progress total steps
public Nullable<Int32> ProgressCurrentSteps { get; set; } #Progress current steps
public String ProgressCurrentOperation { get; set; } #Progress current operation
public String ProgressActivity { get; set; } #Progress activity
public String FullMessage { get; set; } #Message to be written including arguments substitution
public Object[] Args { get; set; } #Arguments used to format Message into FullMessage.