Foxit PDF SDK
FoxitPDFSDKPython3.DateTime Class Reference

Inherits FoxitPDFSDKPython3._object.

Public Member Functions

def DateTime ()
 Constructor.

 
def DateTime (dt)
 Constructor, with another date and time object.
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 Member Functions

def GetLocalTime ()
 Get local time.
More...
 
def GetUTCTime ()
 Get 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.

 
 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.

 

Detailed Description

This class represents date, time and timezone.

Constructor & Destructor Documentation

◆ DateTime()

def FoxitPDFSDKPython3.DateTime.DateTime (   dt)

Constructor, with another date and time object.

Parameters
[in]dtAnother date and time object.

Member Function Documentation

◆ GetLocalTime()

FoxitPDFSDKPython3.DateTime.GetLocalTime ( )
static

Get local time.

Returns
Local time.

◆ GetUTCTime()

FoxitPDFSDKPython3.DateTime.GetUTCTime ( )
static

Get UTC time.

Returns
UTC time.

◆ IsValid()

def FoxitPDFSDKPython3.DateTime.IsValid ( )

Check whether current object is valid or not.

When the current object is not valid, that means current object is useless.

Returns
true means current object is valid, while false means not.

◆ Set()

def FoxitPDFSDKPython3.DateTime.Set (   year,
  month,
  day,
  hour,
  minute,
  second,
  milliseconds,
  utc_hour_offset,
  utc_minute_offset 
)

Set value.

Parameters
[in]yearYear. It should be a four-digit number, such as 2014.
[in]monthMonth. Valid range: from 1 to 12.
[in]dayDay of month. Valid range: from 1 to 31.
[in]hourHour. Valid range: from 0 to 23.
[in]minuteMinute. Valid range: from 0 to 59.
[in]secondSecond. Valid range: from 0 to 60. 60 for leap second.
[in]millisecondsMillisecond. Valid range: from 0 to 999. PDF standard does not support now, this can be omitted if it is not applicable.
[in]utc_hour_offsetHour 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_offsetMinute of time zone. Valid range: from 0 to 59.
Returns
None.

◆ ToLocalTime()

def FoxitPDFSDKPython3.DateTime.ToLocalTime ( )

Convert current object to local time.

Returns
Refernce to current object itself.

◆ ToUTCTime()

def FoxitPDFSDKPython3.DateTime.ToUTCTime ( )

Convert current object to UTC time.

Returns
Refernce to current object itself.

Member Data Documentation

◆ utc_hour_offset

FoxitPDFSDKPython3.DateTime.utc_hour_offset = _swig_property(_fsdk.DateTime_utc_hour_offset_get, _fsdk.DateTime_utc_hour_offset_set)
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.