Label Class
The Label class manages label IDs and label files.
Syntax
class Label extends Object
Run On
Called
Methods
Method | Description | |
---|---|---|
![]() |
bulkEditor | Creates an instance of the LabelBulkEditor class. |
![]() |
cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
![]() |
createLabelFile | Creates a label file for a specified label ID. |
![]() |
delete | Deletes a specified label. |
![]() |
equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
![]() |
exists | Indicates whether a specified label ID exists. |
![]() |
extractComment | Returns a comment associated with a specified label ID. |
![]() |
extractString | Returns the text associated with a specified label ID. |
![]() |
finalize | Closes the current label file. |
![]() |
getFirstLabelFile | Returns the first label file ID record. |
![]() |
getLabelFileCreatedDate | Returns the date that a specified label file was created. |
![]() |
getLabelFileCreatedTime | Returns the time that a specified label file was created. |
![]() |
getLabelFileModificationDate | Returns the date a specified label file was modified. |
![]() |
getLabelFileModificationTime | Returns the time that a specified label file was modified. |
![]() |
getNextLabelFile | Returns the next label file ID record. |
![]() |
getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
![]() |
handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
![]() |
insert | Creates a label ID for a specified text string. |
![]() |
labelId | Returns the number included in a specified label ID. |
![]() |
maxLabelId | Returns the ID for the last label in the specified label file. |
![]() |
modify | Modifies the text and comment associated with a specified label. |
![]() |
moduleId | Returns the label file ID for a specified label ID. |
![]() |
moreLabelFiles | Indicates whether there are additional label files. |
![]() |
name | Returns a label ID based on a specified label file ID and label ID number. |
![]() |
new | Creates a new instance of the Label class. (Overrides the new Method.) |
![]() |
notify | Releases the hold on an object that has called the wait method on this object. (Inherited from Object.) |
![]() |
notifyAll | Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.) |
![]() |
objectOnServer | Determines whether the object is on a server. (Inherited from Object.) |
![]() |
owner | Returns the instance that owns the object. (Inherited from Object.) |
![]() |
searchFirst | Returns the first label ID found for a specified search term. |
![]() |
searchNext | Returns the next label ID found for a search term passed to the method. |
![]() |
setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
![]() |
toString | Returns a string that represents the current object. (Inherited from Object.) |
![]() |
usageCount | Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.) |
![]() |
wait | Pauses a process. (Inherited from Object.) |
![]() |
xml | Returns an XML string that represents the current object. (Inherited from Object.) |
![]() ![]() |
::flush | Flushes the label file buffers to disk. |
Top
Remarks
The SysLabel class extends Label.
Inheritance Hierarchy
Object Class
Label Class
SysLabel Class