NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.DateItemBuilder Class Reference

This class stores a date and time. More...

Inheritance diagram for NXOpen.DateItemBuilder:
NXOpen.GeometricUtilities.IComponentBuilder

Public Types

enum  DayOfMonth {
  Day01, Day02, Day03, Day04,
  Day05, Day06, Day07, Day08,
  Day09, Day10, Day11, Day12,
  Day13, Day14, Day15, Day16,
  Day17, Day18, Day19, Day20,
  Day21, Day22, Day23, Day24,
  Day25, Day26, Day27, Day28,
  Day29, Day30, Day31, Blank
}
 Days of the month More...
 
enum  MonthOfYear {
  Jan, Feb, Mar, Apr,
  May, Jun, Jul, Aug,
  Sep, Oct, Nov, Dec,
  Blank
}
 Months of the year. More...
 

Public Member Functions

unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Properties

unsafe
NXOpen.DateItemBuilder.DayOfMonth 
Day [get, set]
 Returns or sets the day More...
 
unsafe
NXOpen.DateItemBuilder.MonthOfYear 
Month [get, set]
 Returns or sets the month More...
 
unsafe string Time [get, set]
 Returns or sets the time. More...
 
unsafe string Year [get, set]
 Returns or sets the year. More...
 

Detailed Description

This class stores a date and time.

The class does verify that the year string and time string are in a valid format. The first date supported is 2-Jan-1900 00:00:00 UTC and the last date supported is 31st-Dec-9999 00:00:00 UTC. Though note that the time input is in local time and converted to UTC internally.

NOTE: The class does NOT verify that the combination of day, month, year and time is valid.

To create a new instance of this class, use NXOpen.DateBuilder.CreateDateItemBuilder

Created in NX8.0.0

Member Enumeration Documentation

Days of the month

Enumerator
Day01 
Day02 
Day03 
Day04 
Day05 
Day06 
Day07 
Day08 
Day09 
Day10 
Day11 
Day12 
Day13 
Day14 
Day15 
Day16 
Day17 
Day18 
Day19 
Day20 
Day21 
Day22 
Day23 
Day24 
Day25 
Day26 
Day27 
Day28 
Day29 
Day30 
Day31 
Blank 

Months of the year.

Enumerator
Jan 
Feb 
Mar 
Apr 
May 
Jun 
Jul 
Aug 
Sep 
Oct 
Nov 
Dec 
Blank 

Member Function Documentation

unsafe bool NXOpen.DateItemBuilder.Validate ( )

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.DateItemBuilder.DayOfMonth NXOpen.DateItemBuilder.Day
getset

Returns or sets the day

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.DateItemBuilder.MonthOfYear NXOpen.DateItemBuilder.Month
getset

Returns or sets the month

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.DateItemBuilder.Time
getset

Returns or sets the time.

The time string is a 24-hour clock time in the format HH:MM:SS or HH:MM. The string can also be empty.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.DateItemBuilder.Year
getset

Returns or sets the year.

The year string is four characters long and represents an integer within the range minimum year and maximum year (inclusive). The year can also be an empty string.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.