UF_TABNOT_add_column (view source)
Defined in: uf_tabnot.h
Overview
Add a column to a tabular note
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_add_column
(
tag_t tabular_note,
tag_t column,
int index
)
| tag_t | tabular_note | Input | Tabular note |
| tag_t | column | Input | Column |
| int | index | Input | Index of position for column or
UF_TABNOT_APPEND to append to the end |
UF_TABNOT_add_header_row (view source)
Defined in: uf_tabnot.h
Overview
Add a header row to a tabular note
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_add_header_row
(
tag_t tabular_note,
tag_t row,
int index
)
| tag_t | tabular_note | Input | Tabular note |
| tag_t | row | Input | Row |
| int | index | Input | Index of position for row |
UF_TABNOT_add_row (view source)
Defined in: uf_tabnot.h
Overview
Add a row to a tabular note
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_add_row
(
tag_t tabular_note,
tag_t row,
int index
)
| tag_t | tabular_note | Input | Tabular note |
| tag_t | row | Input | Row |
| int | index | Input | Index of position for row or
UF_TABNOT_APPEND to append to the end |
UF_TABNOT_ask_cell_at_row_col (view source)
Defined in: uf_tabnot.h
Overview
Get a cell at the intersection of a row and column
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_cell_at_row_col
(
tag_t row,
tag_t column,
tag_t * cell
)
UF_TABNOT_ask_cell_prefs (view source)
Defined in: uf_tabnot.h
Overview
Get the cell preferences of a cell
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_cell_prefs
(
tag_t cell,
UF_TABNOT_cell_prefs_p_t cell_prefs
)
UF_TABNOT_ask_cell_text (view source)
Defined in: uf_tabnot.h
Overview
Get the defining text of a cell
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_cell_text
(
tag_t cell,
char * * cell_text
)
| tag_t | cell | Input | Cell |
| char * * | cell_text | Output to UF_*free* | Cell text |
UF_TABNOT_ask_column_head_cfw (view source)
Defined in: uf_tabnot.h
Overview
Get the color/font/width settings for the line at the column head
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_column_head_cfw
(
tag_t column,
tag_t section,
int cfw [ 3 ]
)
| tag_t | column | Input | Column |
| tag_t | section | Input | Section |
| int | cfw [ 3 ] | Output | Color/font/width of column head |
UF_TABNOT_ask_column_of_cell (view source)
Defined in: uf_tabnot.h
Overview
Get the column of a cell
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_column_of_cell
(
tag_t cell,
tag_t * column
)
UF_TABNOT_ask_column_sort_data (view source)
Defined in: uf_tabnot.h
Overview
Ask the sort data of a column
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_column_sort_data
(
tag_t column,
UF_TABNOT_sort_data_p_t sort_data
)
UF_TABNOT_ask_column_width (view source)
Defined in: uf_tabnot.h
Overview
Get the width of a column
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_column_width
(
tag_t column,
double * width
)
| tag_t | column | Input | Column |
| double * | width | Output | Width |
UF_TABNOT_ask_default_cell_prefs (view source)
Defined in: uf_tabnot.h
Overview
Retrieves the default cell preferences
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_default_cell_prefs
(
UF_TABNOT_cell_prefs_p_t cell_prefs
)
UF_TABNOT_ask_default_section_prefs (view source)
Defined in: uf_tabnot.h
Overview
Retrieves the default section preferences
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_default_section_prefs
(
UF_TABNOT_section_prefs_p_t section_prefs
)
UF_TABNOT_ask_evaluated_cell_text (view source)
Defined in: uf_tabnot.h
Overview
Get the evaluated text from a tabular note cell
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_evaluated_cell_text
(
tag_t cell,
char * * evaluated_text
)
| tag_t | cell | Input | Tabular note cell |
| char * * | evaluated_text | Output to UF_*free* | Evaluated cell text |
UF_TABNOT_ask_merge_info (view source)
Defined in: uf_tabnot.h
Overview
Get information about merged cells. If the specified cell is a merge
parent (meaning it is the cell in the range of merged cells that contains
the text), returns the start and end rows and columns of the range.
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_merge_info
(
tag_t cell,
tag_t * start_row,
tag_t * start_column,
tag_t * end_row,
tag_t * end_column
)
| tag_t | cell | Input | Cell |
| tag_t * | start_row | Output | Start row or NULL_TAG if cell is not merged |
| tag_t * | start_column | Output | Start column or NULL_TAG if cell is not merged |
| tag_t * | end_row | Output | End row or NULL_TAG if cell is not merged |
| tag_t * | end_column | Output | End column or NULL_TAG if cell is not merged |
UF_TABNOT_ask_nm_columns (view source)
Defined in: uf_tabnot.h
Overview
Get the number of columns in a tabular note
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_nm_columns
(
tag_t tabnote,
int * nm_columns
)
| tag_t | tabnote | Input | Tabular note |
| int * | nm_columns | Output | Number of columns |
UF_TABNOT_ask_nm_header_rows (view source)
Defined in: uf_tabnot.h
Overview
Get the number of header rows in a tabular note
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_nm_header_rows
(
tag_t tabnote,
int * nm_header_rows
)
| tag_t | tabnote | Input | Tabular note |
| int * | nm_header_rows | Output | Number of header rows |
UF_TABNOT_ask_nm_rows (view source)
Defined in: uf_tabnot.h
Overview
Get the number of rows in a tabular note
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_nm_rows
(
tag_t tabnote,
int * nm_rows
)
| tag_t | tabnote | Input | Tabular note |
| int * | nm_rows | Output | Number of rows |
UF_TABNOT_ask_nm_rows_in_section (view source)
Defined in: uf_tabnot.h
Overview
Get the number of rows in a section
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_nm_rows_in_section
(
tag_t section,
int * nm_rows
)
| tag_t | section | Input | Tabular note section |
| int * | nm_rows | Output | Number of rows |
UF_TABNOT_ask_nm_sections (view source)
Defined in: uf_tabnot.h
Overview
Get the number of sections in a tabular note
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_nm_sections
(
tag_t tabnote,
int * nm_sections
)
| tag_t | tabnote | Input | Tabular note |
| int * | nm_sections | Output | Number of sections |
UF_TABNOT_ask_nth_column (view source)
Defined in: uf_tabnot.h
Overview
Get the nth column in a tabular note
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_nth_column
(
tag_t tabnote,
int index,
tag_t * column
)
| tag_t | tabnote | Input | Tabular note |
| int | index | Input | Index of column to retrieve |
| tag_t * | column | Output | Column |
UF_TABNOT_ask_nth_header_row (view source)
Defined in: uf_tabnot.h
Overview
Retrieves the nth header row
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_nth_header_row
(
tag_t tabnote,
int index,
tag_t * row
)
| tag_t | tabnote | Input | The tabular note which has the row |
| int | index | Input | The index of the row |
| tag_t * | row | Output | The nth row |
UF_TABNOT_ask_nth_row (view source)
Defined in: uf_tabnot.h
Overview
Get the nth row in a tabular note
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_nth_row
(
tag_t tabnote,
int index,
tag_t * row
)
| tag_t | tabnote | Input | Tabular note |
| int | index | Input | Index of row to retrieve |
| tag_t * | row | Output | Row |
UF_TABNOT_ask_nth_row_in_section (view source)
Defined in: uf_tabnot.h
Overview
Get the nth row in a section
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_nth_row_in_section
(
tag_t section,
int index,
tag_t * row
)
| tag_t | section | Input | Tabular note section |
| int | index | Input | Index of row to retrieve |
| tag_t * | row | Output | Row |
UF_TABNOT_ask_nth_section (view source)
Defined in: uf_tabnot.h
Overview
Get the nth section in a tabular note
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_nth_section
(
tag_t tabnote,
int index,
tag_t * section
)
| tag_t | tabnote | Input | Tabular note |
| int | index | Input | Index of section to retrieve |
| tag_t * | section | Output | Section |
UF_TABNOT_ask_relative_column (view source)
Defined in: uf_tabnot.h
Overview
Get a column at a position relative to the given column
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_relative_column
(
tag_t column,
int position,
tag_t * relative_column
)
| tag_t | column | Input | Column |
| int | position | Input | Relative position. If position is
less than zero, the column retrieved will
be to the left of given column; if position
is greater than zero, the column retrieved
will be to the right of the given column. |
| tag_t * | relative_column | Output | Relative column |
UF_TABNOT_ask_relative_row (view source)
Defined in: uf_tabnot.h
Overview
Get a row at a position relative to the given row
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_relative_row
(
tag_t row,
int position,
tag_t * relative_row
)
| tag_t | row | Input | Row |
| int | position | Input | Relative position. If position is
less than zero, the row retrieved will be
above the given row; if position is
greater than zero, the row retrieved
will be below the given row. |
| tag_t * | relative_row | Output | Relative row |
UF_TABNOT_ask_row_head_cfw (view source)
Defined in: uf_tabnot.h
Overview
Get the color/font/width settings for the line at the row head
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_row_head_cfw
(
tag_t row,
int cfw [ 3 ]
)
| tag_t | row | Input | Row |
| int | cfw [ 3 ] | Output | Color/font/width of row head |
UF_TABNOT_ask_row_height (view source)
Defined in: uf_tabnot.h
Overview
Get the height of a row
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_row_height
(
tag_t row,
double * height
)
| tag_t | row | Input | Row |
| double * | height | Output | Height |
UF_TABNOT_ask_row_of_cell (view source)
Defined in: uf_tabnot.h
Overview
Get the row of a cell
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_row_of_cell
(
tag_t cell,
tag_t * row
)
UF_TABNOT_ask_section_of_row (view source)
Defined in: uf_tabnot.h
Overview
Get the section of a row
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_section_of_row
(
tag_t row,
tag_t * section
)
UF_TABNOT_ask_section_prefs (view source)
Defined in: uf_tabnot.h
Overview
Get the section preferences of a tabular note section
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_section_prefs
(
tag_t section,
UF_TABNOT_section_prefs_p_t section_prefs
)
UF_TABNOT_ask_tabular_note_of_column (view source)
Defined in: uf_tabnot.h
Overview
Get the tabular note of a column
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_tabular_note_of_column
(
tag_t column,
tag_t * tabular_note
)
| tag_t | column | Input | Column |
| tag_t * | tabular_note | Output | Tabular note |
UF_TABNOT_ask_tabular_note_of_section (view source)
Defined in: uf_tabnot.h
Overview
Get the tabular note of a section
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_ask_tabular_note_of_section
(
tag_t section,
tag_t * tabular_note
)
| tag_t | section | Input | Section |
| tag_t * | tabular_note | Output | Tabular note |
UF_TABNOT_convert_to_non_spreadsheet_tabnote (view source)
Defined in: uf_tabnot.h
Overview
Convert a tabular note that references a spreadsheet to
one for which every cell is an ordinary cell.
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_convert_to_non_spreadsheet_tabnote
(
tag_t tabular_note
)
| tag_t | tabular_note | Input | The tabular note |
UF_TABNOT_create (view source)
Defined in: uf_tabnot.h
Overview
Create a tabular note
Note: Use the functions UF_DRF_ask_origin and UF_DRF_ask_associative_origin
to retrieve the origin of a tabular note section. Use the functions
UF_DRF_set_origin and UF_DRF_set_associative_origin to set the origin
of a tabular note section.
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_create
(
UF_TABNOT_section_prefs_p_t prefs,
double origin [ 3 ] ,
tag_t * tabular_note
)
UF_TABNOT_create_column (view source)
Defined in: uf_tabnot.h
Overview
Create a tabular note column
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_create_column
(
double width,
tag_t * column
)
| double | width | Input | Column width |
| tag_t * | column | Output | New column |
UF_TABNOT_create_from_template (view source)
Defined in: uf_tabnot.h
Overview
Create a tabular note from a template
Note: Use the functions UF_DRF_ask_origin and UF_DRF_ask_associative_origin
to retrieve the origin of a tabular note section. Use the functions
UF_DRF_set_origin and UF_DRF_set_associative_origin to set the origin
of a tabular note section.
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_create_from_template
(
char * template_name,
double origin [ 3 ] ,
tag_t * tabular_note
)
| char * | template_name | Input | Name of template part |
| double | origin [ 3 ] | Input | Origin of the tabular note to create |
| tag_t * | tabular_note | Output | New tabular note |
UF_TABNOT_create_row (view source)
Defined in: uf_tabnot.h
Overview
Create a tabular note row
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_create_row
(
double height,
tag_t * row
)
| double | height | Input | Row height |
| tag_t * | row | Output | New row |
UF_TABNOT_enable_automatic_update (view source)
Defined in: uf_tabnot.h
Overview
Enable or disable the automatic update of tabular notes
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_enable_automatic_update
(
logical allow_automatic_update
)
| logical | allow_automatic_update | Input | Allow automatic update? |
UF_TABNOT_FindAndFixOutOfSynchSpreadsheetTabnotes (view source)
Defined in: uf_tabnot.h
Overview
Find and fix out-of-synch spreadsheet linked tabular notes from input part
Note: The out-of-synch tabular note will be fixed by considering tabular note data as master.
Input :
partTag : Part tag
fixTabnotes : Flag to fix out-of-synch tabular notes,
when false, then this method will only find out-of-synch spreadsheet linked tabular notes from input part.
when true, then this method will find and fix out-of-synch spreadsheet linked tabular notes from input part.
Output :
numTabnotes : Number of out-of-synch tabular notes.
tabnotes : List of out-of-synch tabular notes. Use UF_free to free this memory.
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
History
Released in NX11.0
Required License(s)
drafting
int UF_TABNOT_FindAndFixOutOfSynchSpreadsheetTabnotes
(
tag_t partTag,
logical fixTabnotes,
int * numTabnotes,
tag_t * * tabnotes
)
| tag_t | partTag | Input | Part Tag |
| logical | fixTabnotes | Input | flag to fix out-of-synch tabular notes |
| int * | numTabnotes | Output | number of out-of-synch tabular notes |
| tag_t * * | tabnotes | Output to UF_*free* | list of out-of-synch tabular notes. Use UF_free to free this memory. |
UF_TABNOT_import_spreadsheet_cell (view source)
Defined in: uf_tabnot.h
Overview
Import a spreadsheet cell into a tabular note cell.
Note: This method will change the tag of a tabular note cell object in which
spreadsheet data is imported. The new tag of the tabular note cell can be
queried using the method UF_TABNOT_ask_cell_at_row_col()
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_import_spreadsheet_cell
(
tag_t spreadsheet,
int sheet_number,
int row_number,
int column_number,
tag_t cell
)
| tag_t | spreadsheet | Input | Tag of NX spreadsheet object |
| int | sheet_number | Input | Sheet number in spreadsheet |
| int | row_number | Input | Row number in spreadsheet |
| int | column_number | Input | Column number in spreadsheet |
| tag_t | cell | Input | Cell in a tabular to import into |
UF_TABNOT_merge_cells (view source)
Defined in: uf_tabnot.h
Overview
Merge tabular note cells
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_merge_cells
(
tag_t start_cell,
tag_t end_cell
)
| tag_t | start_cell | Input | Cell at start of range to merge |
| tag_t | end_cell | Input | Cell at end of range to merge |
UF_TABNOT_remove_column (view source)
Defined in: uf_tabnot.h
Overview
Remove a column from a tabular note. Note that this does not delete the column. To
delete the column, use UF_OBJ_delete_object.
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_remove_column
(
tag_t column
)
| tag_t | column | Input | Column to remove |
UF_TABNOT_remove_row (view source)
Defined in: uf_tabnot.h
Overview
Remove a row from a tabular note. Note that this does not delete the row. To
delete the row, use UF_OBJ_delete_object.
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_remove_row
(
tag_t row
)
| tag_t | row | Input | Row to remove |
UF_TABNOT_set_cell_prefs (view source)
Defined in: uf_tabnot.h
Overview
Set the cell preferences of a cell
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_set_cell_prefs
(
tag_t cell,
UF_TABNOT_cell_prefs_p_t cell_prefs
)
UF_TABNOT_set_cell_text (view source)
Defined in: uf_tabnot.h
Overview
Set the defining text of a cell
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_set_cell_text
(
tag_t cell,
const char * cell_text
)
| tag_t | cell | Input | Cell |
| const char * | cell_text | Input | Cell text |
UF_TABNOT_set_column_head_cfw (view source)
Defined in: uf_tabnot.h
Overview
Set the color/font/width settings for the line at the column head
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_set_column_head_cfw
(
tag_t column,
tag_t section,
int cfw [ 3 ]
)
| tag_t | column | Input | Column |
| tag_t | section | Input | Section |
| int | cfw [ 3 ] | Input | Color/font/width of column head |
UF_TABNOT_set_column_sort_data (view source)
Defined in: uf_tabnot.h
Overview
Set the sort data of a column. A subsequent call to UF_TABNOT_sort
will apply the sort data.
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_set_column_sort_data
(
tag_t column,
UF_TABNOT_sort_data_p_t sort_data
)
UF_TABNOT_set_column_width (view source)
Defined in: uf_tabnot.h
Overview
Set the width of a column
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_set_column_width
(
tag_t column,
double width
)
| tag_t | column | Input | Column |
| double | width | Input | Width |
UF_TABNOT_set_default_cell_prefs (view source)
Defined in: uf_tabnot.h
Overview
Sets the default cell preferences
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_set_default_cell_prefs
(
UF_TABNOT_cell_prefs_p_t cell_prefs
)
UF_TABNOT_set_default_section_prefs (view source)
Defined in: uf_tabnot.h
Overview
Sets the default section preferences
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_set_default_section_prefs
(
UF_TABNOT_section_prefs_p_t section_prefs
)
UF_TABNOT_set_row_head_cfw (view source)
Defined in: uf_tabnot.h
Overview
Set the color/font/width settings for the line at the row head
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_set_row_head_cfw
(
tag_t row,
int cfw [ 3 ]
)
| tag_t | row | Input | Row |
| int | cfw [ 3 ] | Input | Color/font/width of row head |
UF_TABNOT_set_row_height (view source)
Defined in: uf_tabnot.h
Overview
Set the height of a row
Note: Fit methods auto size row and auto size text must be disabled
in order for the row height to be reflected on the row.
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_set_row_height
(
tag_t row,
double height
)
| tag_t | row | Input | Row |
| double | height | Input | Height |
UF_TABNOT_set_section_prefs (view source)
Defined in: uf_tabnot.h
Overview
Set the section preferences of a tabular note section
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_set_section_prefs
(
tag_t section,
UF_TABNOT_section_prefs_p_t section_prefs
)
UF_TABNOT_sort (view source)
Defined in: uf_tabnot.h
Overview
Sort the tabular note or parts list after the sort data is set
(using UF_TABNOT_set_column_sort_data) on all the columns.
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
drafting
int UF_TABNOT_sort
(
tag_t tabnote_tag
)
UF_TABNOT_unmerge_cells (view source)
Defined in: uf_tabnot.h
Overview
Unmerge tabular note cells
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
int UF_TABNOT_unmerge_cells
(
tag_t cell
)
| tag_t | cell | Input | Merged cell |
UF_TABNOT_update (view source)
Defined in: uf_tabnot.h
Overview
Force a tabular note to update
Return
Return code :
= 0 : successful
> 0 : failing error number
< 0 : failing error number
Environment
Internal and External
Required License(s)
gateway
int UF_TABNOT_update
(
tag_t tabular_note
)
| tag_t | tabular_note | Input | The tabular note to update |