Multi |
Data neccessary to rename a list of objects (but can also used for instance for exporting a list of objects). The idea behind is to have a bunch of shortcuts, like [N], that can be used as variables for the rename operation.
Since using this class is somewhat complex, see the remarks for the details.
Inheritance HierarchyNamespace: Altaxo.Gui.Common.MultiRename
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
SyntaxC#
public class MultiRenameData
The MultiRenameData type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MultiRenameData | Initializes a new instance of the MultiRenameData class |
Properties| Name | Description | |
|---|---|---|
 | ColumnsOfObjectInformation | Stores columns of information for the objects to rename. Key is the column name. Value is a function which retrieves a string for each object, that appears as text in the column. The first argument of the function is the object (DataTable, Graph, etc.). The second argument is the new calculated name. Note that it is assumed that the first list item corresponds to the old name of the object. This is shown in the first column. The second column is reserved for the new name. Then the other columns follow. |
| DefaultPatternString | Gets or sets the default pattern string, i.e. the pattern string that is initially shown when the multi rename dialog opens. |
| IsRenameOperationFileSystemBased | Sets a value indicating whether the rename operation is file system based (if the names refer to file names). |
| ObjectsToRenameCount | Return the number of objects to be processed (renamed etc). |
| ShowExistingFileInformation | Gets or sets a value indicating whether the generated names are existing files, and it is shown if these files exist. |
Methods| Name | Description | |
|---|---|---|
| AddObjectsToRename | Adds the provided objects to the list of objects to be renamed. |
| DoRename | Calls the function that finally process the items, for instance rename them, export them etc. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetArrayShortcuts | Retrieves the names of all array shortcuts. |
| GetDateTimeShortcuts | Retrieves the names of all DateTime shortcuts. |
| GetDateTimeValueOfShortcut | Gets the value of a DateTime shortcut. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetIntegerShortcuts | Retrieves the names of all integer shortcuts. |
| GetIntegerValueOfShortcut | Gets the integer value of a integer shortcut. |
| GetListValue | Retrieves the value of the Gui list, given the column and the row number. |
| GetNewNameForObject | Gets the proposed new name for the object at position i. |
| GetNewNameForObjectOrNull | Gets the proposed new name for the object at position i. If a new name was not already set, the return value is null. |
| GetObjectToRename | Gets the i-th object to rename. |
| GetShortcutDescription | Gets the description of a shortcut. |
| GetStringArrayValueOfShortcut | Gets the value of an array shortcut. |
| GetStringShortcuts | Retrieves the names of all string shortcuts. |
| GetStringValueOfShortcut | Gets the value of a string shortcut. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| RegisterDateTimeShortcut | Registers a DateTime shortcut. |
| RegisterIntegerShortcut | Registers an integer shortcut. |
| RegisterListColumn(String, FuncObject, String, String) | Register a column for a Gui list that shows the properties of the objects to rename, for instance its old name, its creation date, its new name etc. |
| RegisterListColumn(String, FuncObject, String) | Register a column for a Gui list that shows the properties of the objects to rename, for instance its old name, its creation date, its new name etc. |
| RegisterRenameActionHandler | Registers the rename action handler. This handler is called when the items should be processed (renamed, exported or so). If the function succeeds, the return value should be zero or an empty list. If the function is partially unsuccessfull, for instance because some items could not be renamed, the function should return those unsuccessfully processed items in the list. |
| RegisterStringArrayShortcut | Registers an array shortcut. |
| RegisterStringShortcut | Registers a string shortcut. |
| SetNewNameForObject | Sets the proposed new name for object. Note that the object is not renamed here, instead this is done when calling the rename handler. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Remarks
Momentarily, four different types of shortcuts are implemented:
An Integer shortcut provide a number, a string shortcuts provides a string, a DateTime shortcut a DateTime value and an Array shortcut provides a string array.
In order to use this class for rename operations, after creating an instance of this class you have to:
- Add some objects that you want to process (rename etc.) with AddObjectsToRename(IEnumerableObject)
- Add some shortcuts that can be used as variables for flexible renaming with RegisterIntegerShortcut(String, FuncObject, Int32, Int32, String), RegisterStringShortcut(String, FuncObject, Int32, String, String), RegisterDateTimeShortcut(String, FuncObject, Int32, DateTime, String) or RegisterStringArrayShortcut(String, FuncObject, Int32, String, String).
- Add some columns for the list that should be shown in the rename dialog with RegisterListColumn(String, FuncObject, String). One of the calls to RegisterListColumn(String, FuncObject, String) should designate the column with the new name of the objects, in this case the 2nd argument (the handler) should be null.
- Add a handler that will do the processing of the items (renaming, exporting etc). with RegisterRenameActionHandler(FuncMultiRenameData, ListObject).
- Set the value of DefaultPatternString to a value that should be initially shown as pattern when the rename dialog opens, for instance [N].
See Also