DtObj Dart Reference Documentation
CkDtObj
Current Version: 11.6.1
Chilkat.DtObj
Store and edit the year, month, day, hour, minute, and second as
individual properties.
Use the UTC flag to indicate whether the stored fields represent UTC or
local time.
Use alternate month and year properties when working with
Save and restore the object using Chilkat's compact internal serialized
date/time representation.
Pass
Use this class as a simple container rather than a full date/time
calculation or timezone-conversion engine.
For an extended overview, see
DtObj Class Overview.
Represent a date/time as simple editable fields.
Chilkat.DtObj is a lightweight date/time value object used by
Chilkat methods that need to pass or return individual date and time fields.
It stores values such as year, month, day, hour, minute, and second, along
with a flag indicating whether the value represents UTC or local time. It
also provides a compact serialization format for saving and restoring the
date/time value.
Simple date fields
UTC or local time
Struct tm compatibility
struct tm-style date/time conventions.
Serialize and restore
Used by other classes
DtObj values to Chilkat methods that require explicit
date/time fields or return date/time information.
Small and focused
DtObj, set or read the individual date/time
fields, check whether the value is UTC or local time, and pass the object to
another Chilkat method. Use serialization only when the date/time value needs
to be saved and restored in Chilkat's compact internal format.
Object Creation
// pubspec.yaml:
// dependencies:
// chilkat: ^11.6.1
import 'package:chilkat/chilkat.dart';
// Once per process, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial'); // shorthand for CkGlobal().unlockBundle(..)
final dtObj = CkDtObj();
// ... the native object is released when `dtObj` is garbage collected, or now with dtObj.dispose().Creates the underlying native Chilkat object. Use a CkDtObj only from the isolate that created it: Chilkat objects cannot be sent between isolates. Every call is synchronous; in a Flutter app, run long operations (network, large files) inside Isolate.run, creating the Chilkat objects inside the isolate.
Releases the native object immediately instead of waiting for garbage collection (useful for a large CkBinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws a StateError. isDisposed tells whether it has been called.
Errors
A method that can fail throws a ChilkatException: a method whose only outcome is success or failure returns void and throws on failure; a method producing a String or an object returns it and throws where Chilkat would have returned null. The exception carries the object's LastErrorText at the time of the failure (lastErrorText), the class and method names (className, methodName) and a one-line message. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain bool.
try {
dtObj.someMethod(...);
} on ChilkatException catch (e) {
print(e); // CkDtObj.someMethod failed: <reason>
print(e.lastErrorText); // the full Chilkat log of the failed call
}Properties
Day
int get day
set day(int value)
The day of the month. The valid values for this member are 1 through 31.
topDebugLogFilePath
String get debugLogFilePath
set debugLogFilePath(String value)
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
Hour
int get hour
set hour(int value)
The hour. The valid values for this member are 0 through 23.
topLastErrorHtml
String get lastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
String get lastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
String get lastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
bool get lastMethodSuccess
set lastMethodSuccess(bool value)
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
Minute
int get minute
set minute(int value)
The minute. The valid values for this member are 0 through 59.
topMonth
int get month
set month(int value)
The month. The valid values for this member are 1 through 12 where 1 = January and 12 = December.
topSecond
int get second
set second(int value)
The second. The valid values for this member are 0 through 59.
topStructTmMonth
int get structTmMonth
set structTmMonth(int value)
The month. The valid values for this member are 0 through 11 where 0 = January and 11 = December.
topStructTmYear
int get structTmYear
set structTmYear(int value)
The year represented as the number of years since 1900.
topUtc
bool get utc
set utc(bool value)
true if this is a UTC time, otherwise false if this is a local time.
VerboseLogging
bool get verboseLogging
set verboseLogging(bool value)
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
String get version
Year
int get year
set year(int value)
The year, such as 2012.
topMethods
DeSerialize
Loads the date/time with a string having the format as produced by the Serialize method, which is a string of SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1/0.
topSerialize
Serializes the date/time to a us-ascii string that can be imported at a later time via the DeSerialize method. The format of the string returned by this method is not intended to match any published standard. It is formatted to a string with SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1/0.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).