NXOpen .NET Reference  12.0.0
Classes | Public Types | Public Member Functions | List of all members
NXOpen.UF.UFPlist Class Reference

Contains wrappers for all 'UF_PLIST' functions and data types. More...

Inheritance diagram for NXOpen.UF.UFPlist:

Classes

struct  _ColPrefs
 
struct  _FieldFormat
 
struct  _Prefs
 
struct  ColPrefs
 Wrapper for UF_PLIST_col_prefs_s More...
 
struct  FieldFormat
 Wrapper for UF_PLIST_field_format_s More...
 
struct  Prefs
 Wrapper for UF_PLIST_prefs_s More...
 
struct  TraversalSettings
 Wrapper for UF_PLIST_traversal_settings_s More...
 

Public Types

enum  GrowDirection
 Wrapper for UF_PLIST_grow_direction_t More...
 
enum  LdrMethod
 Wrapper for UF_PLIST_ldr_method_t More...
 
enum  SymbolType
 Wrapper for UF_PLIST_symbol_type_t More...
 
enum  ColumnType
 Wrapper for UF_PLIST_column_type_t More...
 

Public Member Functions

void AddEntities (NXOpen.Tag obj_id, int num_to_add, NXOpen.Tag[] objects)
 DEPRECATED Wrapper method for UF_PLIST_add_entities More...
 
void AddObject (NXOpen.Tag parts_list, bool add_components_as_subassemblies, NXOpen.Tag _object)
 Wrapper method for UF_PLIST_add_object More...
 
unsafe void AskAttachedRows (NXOpen.Tag parent, out int nm_rows, out NXOpen.Tag[] children_rows)
 Wrapper method for UF_PLIST_ask_attached_rows More...
 
unsafe void AskColPrefs (NXOpen.Tag col, out ColPrefs col_prefs)
 Wrapper method for UF_PLIST_ask_col_prefs More...
 
unsafe void AskDefaultColPrefs (out ColPrefs col_prefs)
 Wrapper method for UF_PLIST_ask_default_col_prefs More...
 
unsafe void AskDefaultPrefs (out Prefs plist_prefs)
 Wrapper method for UF_PLIST_ask_default_prefs More...
 
void AskLdrMethod (NXOpen.Tag row, out int ldr_method)
 Wrapper method for UF_PLIST_ask_ldr_method More...
 
void AskNestedAssyParentComp (NXOpen.Tag column, out NXOpen.Tag component)
 Wrapper method for UF_PLIST_ask_nested_assy_parent_comp More...
 
unsafe void AskObjects (NXOpen.Tag parts_list, out int nm_objects, out NXOpen.Tag[] objects)
 Wrapper method for UF_PLIST_ask_objects More...
 
unsafe void AskPrefs (NXOpen.Tag parts_list, out Prefs prefs)
 Wrapper method for UF_PLIST_ask_prefs More...
 
void AskRowLock (NXOpen.Tag row, out bool lock_state)
 Wrapper method for UF_PLIST_ask_row_lock More...
 
NXOpen.Tag AskTag ()
 DEPRECATED Wrapper method for UF_PLIST_ask_tag More...
 
NXOpen.Tag AskTagOfNote (NXOpen.Tag obj_id)
 DEPRECATED Wrapper method for UF_PLIST_ask_tag_of_note More...
 
unsafe void AskTags (out NXOpen.Tag[] parts_list, out int num)
 Wrapper method for UF_PLIST_ask_tags More...
 
void AskTraversalSettings (NXOpen.Tag parts_list, out TraversalSettings traversal_settings)
 Wrapper method for UF_PLIST_ask_traversal_settings More...
 
void AttachRows (NXOpen.Tag parent_row, int nm_rows, NXOpen.Tag[] children_rows)
 Wrapper method for UF_PLIST_attach_rows More...
 
unsafe void Create (ref Prefs prefs, double[] origin, out NXOpen.Tag parts_list)
 Wrapper method for UF_PLIST_create More...
 
unsafe void CreateColumn (double width, ref ColPrefs col_prefs, ColumnType column_type, out NXOpen.Tag column)
 Wrapper method for UF_PLIST_create_column More...
 
void CreateFromTemplate (string template_name, double[] origin, out NXOpen.Tag parts_list)
 Wrapper method for UF_PLIST_create_from_template More...
 
void CreateManualRow (double height, out NXOpen.Tag row)
 Wrapper method for UF_PLIST_create_manual_row More...
 
void CreateNote (NXOpen.Tag obj_id, double[] position, out NXOpen.Tag note_obj_id)
 DEPRECATED Wrapper method for UF_PLIST_create_note More...
 
unsafe void DefineField (NXOpen.Tag obj_id, int pos, string line_1, string line_2, string attr_title, ref FieldFormat f_format, int f_width, int f_type, int p_mask)
 DEPRECATED Wrapper method for UF_PLIST_define_field More...
 
void List (NXOpen.Tag obj_id)
 Wrapper method for UF_PLIST_list More...
 
void ListToFile (NXOpen.Tag obj_id, string out_filename, int new_file, string plist_level)
 Wrapper method for UF_PLIST_list_to_file More...
 
void RemoveEntity (NXOpen.Tag obj_id, int num_to_add, NXOpen.Tag[] objects)
 DEPRECATED Wrapper method for UF_PLIST_remove_entity More...
 
void RemoveField (NXOpen.Tag obj_id, int field)
 DEPRECATED Wrapper method for UF_PLIST_remove_field More...
 
void RemoveObject (NXOpen.Tag parts_list, bool remove_components_as_subassemblies, NXOpen.Tag _object)
 Wrapper method for UF_PLIST_remove_object More...
 
unsafe void SetColPrefs (NXOpen.Tag col, ref ColPrefs col_prefs)
 Wrapper method for UF_PLIST_set_col_prefs More...
 
void SetColumnModes (NXOpen.Tag obj_id, int rowmax, int rowpos, int rowgap)
 DEPRECATED Wrapper method for UF_PLIST_set_column_modes More...
 
unsafe void SetDefaultPrefs (ref Prefs plist_prefs)
 Wrapper method for UF_PLIST_set_default_prefs More...
 
void SetDisplayModes (NXOpen.Tag obj_id, string attr_title, int sort_mode, int header_mode, int callout_mode, int box_mode, int report_mode, int symbol_mode, double line_space)
 DEPRECATED Wrapper method for UF_PLIST_set_display_modes More...
 
void SetFitCharSizes (NXOpen.Tag obj_id, int csize_option, int dash_option, double ccsize, double dcsize)
 DEPRECATED Wrapper method for UF_PLIST_set_fit_char_sizes More...
 
void SetFitRules (NXOpen.Tag obj_id, int[] priorities)
 DEPRECATED Wrapper method for UF_PLIST_set_fit_rules More...
 
void SetFrozenLevel (NXOpen.Tag obj_id, int value)
 DEPRECATED Wrapper method for UF_PLIST_set_frozen_level More...
 
void SetNestedAssyParentComp (NXOpen.Tag column, NXOpen.Tag component)
 Wrapper method for UF_PLIST_set_nested_assy_parent_comp More...
 
unsafe void SetPrefs (NXOpen.Tag parts_list, ref Prefs prefs)
 Wrapper method for UF_PLIST_set_prefs More...
 
void SetReportMode (NXOpen.Tag obj_id, int value)
 DEPRECATED Wrapper method for UF_PLIST_set_report_mode More...
 
void SetRowLock (NXOpen.Tag row, bool lock_state)
 Wrapper method for UF_PLIST_set_row_lock More...
 
void SetSecondSort (NXOpen.Tag obj_id, string attr_title, int smode2)
 DEPRECATED Wrapper method for UF_PLIST_set_second_sort More...
 
void SetSkipLevel (NXOpen.Tag obj_id, int value)
 DEPRECATED Wrapper method for UF_PLIST_set_skip_level More...
 
void SetTraversalSettings (NXOpen.Tag parts_list, ref TraversalSettings traversal_settings)
 Wrapper method for UF_PLIST_set_traversal_settings More...
 
void Update (NXOpen.Tag parts_list)
 Wrapper method for UF_PLIST_update More...
 
void UpdateAllPlists ()
 Wrapper method for UF_PLIST_update_all_plists More...
 

Detailed Description

Contains wrappers for all 'UF_PLIST' functions and data types.

Member Enumeration Documentation

Wrapper for UF_PLIST_column_type_t

Refer to UF_PLIST_column_type_t for documentation
Mapping Help

Wrapper for UF_PLIST_grow_direction_t

Refer to UF_PLIST_grow_direction_t for documentation
Mapping Help

Wrapper for UF_PLIST_ldr_method_t

Refer to UF_PLIST_ldr_method_t for documentation
Mapping Help

Wrapper for UF_PLIST_symbol_type_t

Refer to UF_PLIST_symbol_type_t for documentation
Mapping Help

Member Function Documentation

void NXOpen.UF.UFPlist.AddEntities ( NXOpen.Tag  obj_id,
int  num_to_add,
NXOpen.Tag[]  objects 
)

DEPRECATED Wrapper method for UF_PLIST_add_entities

Refer to UF_PLIST_add_entities for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.AddObject ( NXOpen.Tag  parts_list,
bool  add_components_as_subassemblies,
NXOpen.Tag  _object 
)

Wrapper method for UF_PLIST_add_object

Refer to UF_PLIST_add_object for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UFPlist.AskAttachedRows ( NXOpen.Tag  parent,
out int  nm_rows,
out NXOpen.Tag[]  children_rows 
)

Wrapper method for UF_PLIST_ask_attached_rows

Refer to UF_PLIST_ask_attached_rows for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UFPlist.AskColPrefs ( NXOpen.Tag  col,
out ColPrefs  col_prefs 
)

Wrapper method for UF_PLIST_ask_col_prefs

Refer to UF_PLIST_ask_col_prefs for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UFPlist.AskDefaultColPrefs ( out ColPrefs  col_prefs)

Wrapper method for UF_PLIST_ask_default_col_prefs

Refer to UF_PLIST_ask_default_col_prefs for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UFPlist.AskDefaultPrefs ( out Prefs  plist_prefs)

Wrapper method for UF_PLIST_ask_default_prefs

Refer to UF_PLIST_ask_default_prefs for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.AskLdrMethod ( NXOpen.Tag  row,
out int  ldr_method 
)

Wrapper method for UF_PLIST_ask_ldr_method

Refer to UF_PLIST_ask_ldr_method for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.AskNestedAssyParentComp ( NXOpen.Tag  column,
out NXOpen.Tag  component 
)

Wrapper method for UF_PLIST_ask_nested_assy_parent_comp

Refer to UF_PLIST_ask_nested_assy_parent_comp for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UFPlist.AskObjects ( NXOpen.Tag  parts_list,
out int  nm_objects,
out NXOpen.Tag[]  objects 
)

Wrapper method for UF_PLIST_ask_objects

Refer to UF_PLIST_ask_objects for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UFPlist.AskPrefs ( NXOpen.Tag  parts_list,
out Prefs  prefs 
)

Wrapper method for UF_PLIST_ask_prefs

Refer to UF_PLIST_ask_prefs for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.AskRowLock ( NXOpen.Tag  row,
out bool  lock_state 
)

Wrapper method for UF_PLIST_ask_row_lock

Refer to UF_PLIST_ask_row_lock for documentation
Mapping Help

License requirements:None

NXOpen.Tag NXOpen.UF.UFPlist.AskTag ( )

DEPRECATED Wrapper method for UF_PLIST_ask_tag

Refer to UF_PLIST_ask_tag for documentation
Mapping Help

License requirements:None

NXOpen.Tag NXOpen.UF.UFPlist.AskTagOfNote ( NXOpen.Tag  obj_id)

DEPRECATED Wrapper method for UF_PLIST_ask_tag_of_note

Refer to UF_PLIST_ask_tag_of_note for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UFPlist.AskTags ( out NXOpen.Tag[]  parts_list,
out int  num 
)

Wrapper method for UF_PLIST_ask_tags

Refer to UF_PLIST_ask_tags for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.AskTraversalSettings ( NXOpen.Tag  parts_list,
out TraversalSettings  traversal_settings 
)

Wrapper method for UF_PLIST_ask_traversal_settings

Refer to UF_PLIST_ask_traversal_settings for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.AttachRows ( NXOpen.Tag  parent_row,
int  nm_rows,
NXOpen.Tag[]  children_rows 
)

Wrapper method for UF_PLIST_attach_rows

Refer to UF_PLIST_attach_rows for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UFPlist.Create ( ref Prefs  prefs,
double[]  origin,
out NXOpen.Tag  parts_list 
)

Wrapper method for UF_PLIST_create

Refer to UF_PLIST_create for documentation
Mapping Help

License requirements:DRAFTING

unsafe void NXOpen.UF.UFPlist.CreateColumn ( double  width,
ref ColPrefs  col_prefs,
ColumnType  column_type,
out NXOpen.Tag  column 
)

Wrapper method for UF_PLIST_create_column

Refer to UF_PLIST_create_column for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.CreateFromTemplate ( string  template_name,
double[]  origin,
out NXOpen.Tag  parts_list 
)

Wrapper method for UF_PLIST_create_from_template

Refer to UF_PLIST_create_from_template for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.CreateManualRow ( double  height,
out NXOpen.Tag  row 
)

Wrapper method for UF_PLIST_create_manual_row

Refer to UF_PLIST_create_manual_row for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.CreateNote ( NXOpen.Tag  obj_id,
double[]  position,
out NXOpen.Tag  note_obj_id 
)

DEPRECATED Wrapper method for UF_PLIST_create_note

Refer to UF_PLIST_create_note for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UFPlist.DefineField ( NXOpen.Tag  obj_id,
int  pos,
string  line_1,
string  line_2,
string  attr_title,
ref FieldFormat  f_format,
int  f_width,
int  f_type,
int  p_mask 
)

DEPRECATED Wrapper method for UF_PLIST_define_field

Refer to UF_PLIST_define_field for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.List ( NXOpen.Tag  obj_id)

Wrapper method for UF_PLIST_list

Refer to UF_PLIST_list for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.ListToFile ( NXOpen.Tag  obj_id,
string  out_filename,
int  new_file,
string  plist_level 
)

Wrapper method for UF_PLIST_list_to_file

Refer to UF_PLIST_list_to_file for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.RemoveEntity ( NXOpen.Tag  obj_id,
int  num_to_add,
NXOpen.Tag[]  objects 
)

DEPRECATED Wrapper method for UF_PLIST_remove_entity

Refer to UF_PLIST_remove_entity for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.RemoveField ( NXOpen.Tag  obj_id,
int  field 
)

DEPRECATED Wrapper method for UF_PLIST_remove_field

Refer to UF_PLIST_remove_field for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.RemoveObject ( NXOpen.Tag  parts_list,
bool  remove_components_as_subassemblies,
NXOpen.Tag  _object 
)

Wrapper method for UF_PLIST_remove_object

Refer to UF_PLIST_remove_object for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UFPlist.SetColPrefs ( NXOpen.Tag  col,
ref ColPrefs  col_prefs 
)

Wrapper method for UF_PLIST_set_col_prefs

Refer to UF_PLIST_set_col_prefs for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.SetColumnModes ( NXOpen.Tag  obj_id,
int  rowmax,
int  rowpos,
int  rowgap 
)

DEPRECATED Wrapper method for UF_PLIST_set_column_modes

Refer to UF_PLIST_set_column_modes for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UFPlist.SetDefaultPrefs ( ref Prefs  plist_prefs)

Wrapper method for UF_PLIST_set_default_prefs

Refer to UF_PLIST_set_default_prefs for documentation
Mapping Help

License requirements:DRAFTING

void NXOpen.UF.UFPlist.SetDisplayModes ( NXOpen.Tag  obj_id,
string  attr_title,
int  sort_mode,
int  header_mode,
int  callout_mode,
int  box_mode,
int  report_mode,
int  symbol_mode,
double  line_space 
)

DEPRECATED Wrapper method for UF_PLIST_set_display_modes

Refer to UF_PLIST_set_display_modes for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.SetFitCharSizes ( NXOpen.Tag  obj_id,
int  csize_option,
int  dash_option,
double  ccsize,
double  dcsize 
)

DEPRECATED Wrapper method for UF_PLIST_set_fit_char_sizes

Refer to UF_PLIST_set_fit_char_sizes for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.SetFitRules ( NXOpen.Tag  obj_id,
int[]  priorities 
)

DEPRECATED Wrapper method for UF_PLIST_set_fit_rules

Refer to UF_PLIST_set_fit_rules for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.SetFrozenLevel ( NXOpen.Tag  obj_id,
int  value 
)

DEPRECATED Wrapper method for UF_PLIST_set_frozen_level

Refer to UF_PLIST_set_frozen_level for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.SetNestedAssyParentComp ( NXOpen.Tag  column,
NXOpen.Tag  component 
)

Wrapper method for UF_PLIST_set_nested_assy_parent_comp

Refer to UF_PLIST_set_nested_assy_parent_comp for documentation
Mapping Help

License requirements:None

unsafe void NXOpen.UF.UFPlist.SetPrefs ( NXOpen.Tag  parts_list,
ref Prefs  prefs 
)

Wrapper method for UF_PLIST_set_prefs

Refer to UF_PLIST_set_prefs for documentation
Mapping Help

License requirements:DRAFTING

void NXOpen.UF.UFPlist.SetReportMode ( NXOpen.Tag  obj_id,
int  value 
)

DEPRECATED Wrapper method for UF_PLIST_set_report_mode

Refer to UF_PLIST_set_report_mode for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.SetRowLock ( NXOpen.Tag  row,
bool  lock_state 
)

Wrapper method for UF_PLIST_set_row_lock

Refer to UF_PLIST_set_row_lock for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.SetSecondSort ( NXOpen.Tag  obj_id,
string  attr_title,
int  smode2 
)

DEPRECATED Wrapper method for UF_PLIST_set_second_sort

Refer to UF_PLIST_set_second_sort for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.SetSkipLevel ( NXOpen.Tag  obj_id,
int  value 
)

DEPRECATED Wrapper method for UF_PLIST_set_skip_level

Refer to UF_PLIST_set_skip_level for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.SetTraversalSettings ( NXOpen.Tag  parts_list,
ref TraversalSettings  traversal_settings 
)

Wrapper method for UF_PLIST_set_traversal_settings

Refer to UF_PLIST_set_traversal_settings for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.Update ( NXOpen.Tag  parts_list)

Wrapper method for UF_PLIST_update

Refer to UF_PLIST_update for documentation
Mapping Help

License requirements:None

void NXOpen.UF.UFPlist.UpdateAllPlists ( )

Wrapper method for UF_PLIST_update_all_plists

Refer to UF_PLIST_update_all_plists for documentation
Mapping Help

License requirements:None


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