Foxit PDF SDK
|
Public Member Functions | |
constructor () | |
Constructor. | |
constructor (year, month, day, hour, minute, second, milliseconds, utc_hour_offset, utc_minute_offset) | |
Constructor, with parameters. More... | |
IsValid () | |
Check whether current object is valid or not. More... | |
Set (year, month, day, hour, minute, second, milliseconds, utc_hour_offset, utc_minute_offset) | |
Set value. More... | |
ToLocalTime () | |
Convert current object to local time. More... | |
ToUTCTime () | |
Convert current object to UTC time. More... | |
Static Public Member Functions | |
static | GetLocalTime () |
Get local time. More... | |
static | GetUTCTime () |
Get UTC time. More... | |
Public Attributes | |
day | |
Day of month. Valid range: from 1 to 31. | |
hour | |
Hour. Valid range: from 0 to 23. | |
milliseconds | |
Millisecond. Valid range: from 0 to 999. PDF standard does not support now, this can be omitted if it is not applicable. | |
minute | |
Minute. Valid range: from 0 to 59. | |
month | |
Month. Valid range: from 1 to 12. | |
second | |
Second. Valid range: from 0 to 60. 60 for leap second. | |
utc_hour_offset | |
Hour of time zone. Valid range: from -12 to 12. More... | |
utc_minute_offset | |
Minute of time zone. Valid range: from 0 to 59. | |
year | |
Year. It should be a four-digit number, such as 2014. | |
This class represents date, time and timezone.
FSDK.DateTime.constructor | ( | year | , |
month | , | ||
day | , | ||
hour | , | ||
minute | , | ||
second | , | ||
milliseconds | , | ||
utc_hour_offset | , | ||
utc_minute_offset | |||
) |
Constructor, with parameters.
[in] | year | Year. It should be a four-digit number, such as 2014. |
[in] | month | Month. Valid range: from 1 to 12. |
[in] | day | Day of month. Valid range: from 1 to 31. |
[in] | hour | Hour. Valid range: from 0 to 23. |
[in] | minute | Minute. Valid range: from 0 to 59. |
[in] | second | Second. Valid range: from 0 to 60. 60 for leap second. |
[in] | milliseconds | Millisecond. Valid range: from 0 to 999. PDF standard does not support now, this can be omitted if it is not applicable. |
[in] | utc_hour_offset | Hour of time zone. Valid range: from -12 to 12. Positive value for the eastern time zone, and negative value for the western time zone. |
[in] | utc_minute_offset | Minute of time zone. Valid range: from 0 to 59. |
|
static |
Get local time.
|
static |
Get UTC time.
FSDK.DateTime.IsValid | ( | ) |
Check whether current object is valid or not.
When the current object is not valid, that means current object is useless.
FSDK.DateTime.Set | ( | year | , |
month | , | ||
day | , | ||
hour | , | ||
minute | , | ||
second | , | ||
milliseconds | , | ||
utc_hour_offset | , | ||
utc_minute_offset | |||
) |
Set value.
[in] | year | Year. It should be a four-digit number, such as 2014. |
[in] | month | Month. Valid range: from 1 to 12. |
[in] | day | Day of month. Valid range: from 1 to 31. |
[in] | hour | Hour. Valid range: from 0 to 23. |
[in] | minute | Minute. Valid range: from 0 to 59. |
[in] | second | Second. Valid range: from 0 to 60. 60 for leap second. |
[in] | milliseconds | Millisecond. Valid range: from 0 to 999. PDF standard does not support now, this can be omitted if it is not applicable. |
[in] | utc_hour_offset | Hour of time zone. Valid range: from -12 to 12. Positive value for the eastern time zone, and negative value for the western time zone. |
[in] | utc_minute_offset | Minute of time zone. Valid range: from 0 to 59. |
FSDK.DateTime.ToLocalTime | ( | ) |
Convert current object to local time.
FSDK.DateTime.ToUTCTime | ( | ) |
Convert current object to UTC time.
FSDK.DateTime.utc_hour_offset |
Hour of time zone. Valid range: from -12 to 12.
Positive value for the eastern time zone, and negative value for the western time zone.