Foxit PDF SDK
|
Inherits FoxitPDFSDKPython2._object.
Public Member Functions | |
def | DateTime (year, month, day, hour, minute, second, milliseconds, utc_hour_offset, utc_minute_offset) |
Constructor, with parameters. More... | |
def | IsValid () |
Check whether current object is valid or not. More... | |
def | Set (year, month, day, hour, minute, second, milliseconds, utc_hour_offset, utc_minute_offset) |
Set value. More... | |
def | ToLocalTime () |
Convert current object to local time. More... | |
def | ToUTCTime () |
Convert current object to UTC time. More... | |
Static Public Attributes | |
day = _swig_property(_fsdk.DateTime_day_get, _fsdk.DateTime_day_set) | |
Day of month. Valid range: from 1 to 31. | |
GetLocalTime = _fsdk.DateTime_GetLocalTime | |
Get local time. More... | |
GetUTCTime = _fsdk.DateTime_GetUTCTime | |
Get UTC time. More... | |
hour = _swig_property(_fsdk.DateTime_hour_get, _fsdk.DateTime_hour_set) | |
Hour. Valid range: from 0 to 23. | |
milliseconds = _swig_property(_fsdk.DateTime_milliseconds_get, _fsdk.DateTime_milliseconds_set) | |
Millisecond. Valid range: from 0 to 999. PDF standard does not support now, this can be omitted if it is not applicable. | |
minute = _swig_property(_fsdk.DateTime_minute_get, _fsdk.DateTime_minute_set) | |
Minute. Valid range: from 0 to 59. | |
month = _swig_property(_fsdk.DateTime_month_get, _fsdk.DateTime_month_set) | |
Month. Valid range: from 1 to 12. | |
second = _swig_property(_fsdk.DateTime_second_get, _fsdk.DateTime_second_set) | |
Second. Valid range: from 0 to 60. 60 for leap second. | |
utc_hour_offset = _swig_property(_fsdk.DateTime_utc_hour_offset_get, _fsdk.DateTime_utc_hour_offset_set) | |
Hour of time zone. Valid range: from -12 to 12. More... | |
utc_minute_offset = _swig_property(_fsdk.DateTime_utc_minute_offset_get, _fsdk.DateTime_utc_minute_offset_set) | |
Minute of time zone. Valid range: from 0 to 59. | |
year = _swig_property(_fsdk.DateTime_year_get, _fsdk.DateTime_year_set) | |
Year. It should be a four-digit number, such as 2014. | |
This class represents date, time and timezone.
def FoxitPDFSDKPython2.DateTime.DateTime | ( | year, | |
month, | |||
day, | |||
hour, | |||
minute, | |||
second, | |||
milliseconds, | |||
utc_hour_offset, | |||
utc_minute_offset | |||
) |
Constructor, with parameters.
Constructor, with another date and time object.
Constructor.
[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. |
[in] | dt | Another date and time object. |
def FoxitPDFSDKPython2.DateTime.IsValid | ( | ) |
Check whether current object is valid or not.
When the current object is not valid, that means current object is useless.
def FoxitPDFSDKPython2.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. |
def FoxitPDFSDKPython2.DateTime.ToLocalTime | ( | ) |
Convert current object to local time.
def FoxitPDFSDKPython2.DateTime.ToUTCTime | ( | ) |
Convert current object to UTC time.
|
static |
Get local time.
|
static |
Get UTC time.
|
static |
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.