IOLink C# 1.16.1
Loading...
Searching...
No Matches
IOLink.ColumnRenamingExtension Class Reference
Inheritance diagram for IOLink.ColumnRenamingExtension:
IOLink.Extension

Public Member Functions

 ColumnRenamingExtension (global::System.IntPtr cPtr, bool cMemoryOwn)
 
virtual void SetColumnName (string columnName, string newName)
 Set the name of a column identified with its name.
 
virtual void SetColumnName (uint index, string newName)
 Set the name of a column identified with its index.
 

Static Public Member Functions

static global::System.Runtime.InteropServices.HandleRef getCPtr (ColumnRenamingExtension obj)
 
static ColumnRenamingExtension Cast (Extension extension)
 Upcast a generic extension to this specific type.
 

Static Public Attributes

static readonly uint EXTENSION_ID = IOLinkPINVOKE.ColumnRenamingExtension_EXTENSION_ID_get()
 Identifier used to load the extension using the View::extension method.
 

Protected Member Functions

override void Dispose (bool disposing)
 

Detailed Description

Extension to provide the way to rename a column. This extension allows to set the name of a column in a dataframe.

Member Function Documentation

◆ Cast()

static ColumnRenamingExtension IOLink.ColumnRenamingExtension.Cast ( Extension  extension)
inlinestatic

Upcast a generic extension to this specific type.

Parameters
extensionThe extension to cast.
Returns
The upcasted extension. This will be null if no upcasting is possible.

◆ Dispose()

override void IOLink.ColumnRenamingExtension.Dispose ( bool  disposing)
inlineprotectedvirtual

Reimplemented from IOLink.Extension.

◆ SetColumnName() [1/2]

virtual void IOLink.ColumnRenamingExtension.SetColumnName ( string  columnName,
string  newName 
)
inlinevirtual

Set the name of a column identified with its name.

Parameters
columnNameThe name of the column to rename.
newNameThe name to assign to the column.
Exceptions
Errorif the given column name does not exist in the DataFrame.
InvalidArgumentif the given new name already exists in the DataFrame.
Errorif DataFrameView does not have the WRITE capability.

◆ SetColumnName() [2/2]

virtual void IOLink.ColumnRenamingExtension.SetColumnName ( uint  index,
string  newName 
)
inlinevirtual

Set the name of a column identified with its index.

Parameters
newNameThe name to assign to the column.
Exceptions
Errorif the given column index is out of range.
InvalidArgumentif the given new name already exists in the DataFrame.
Errorif DataFrameView does not have the WRITE capability.

The documentation for this class was generated from the following file: