Difference between revisions of "FileNamespace class"
Line 1: | Line 1: | ||
− | {{CGscriptClass_Template |Name=FileNamespace |Description=The file namespace |Methods= {{CGscriptMethods_Template|ReturnType= | + | {{CGscriptClass_Template |
− | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file | + | |Name=FileNamespace |
− | |Description= | + | |Description=The file namespace |
− | + | |Methods= | |
− | {{CGscriptMethods_Template|ReturnType= | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=AppendAllLines|Parameters= |
− | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file | + | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=content|Description=The content of the file}} |
− | |Description= | + | |Description=Opens a text file, Append all lines of the file, and then closes the file.}} |
− | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=AppendAllText|Parameters= | |
+ | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=content|Description=The content of the file}} | ||
+ | |Description=Opens a text file, Append all lines of the file, and then closes the file.}} | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=Delete|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=Delete|Parameters= | ||
{{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary}} | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary}} | ||
|Description=Deletes a file.}} | |Description=Deletes a file.}} | ||
− | + | {{CGscriptMethods_Template|ReturnType=string|Name=GenerateRandomFilename|Description=Provides a new random filename.}} | |
+ | {{CGscriptMethods_Template|ReturnType=DateTime|Name=GetCreationTime|Parameters= | ||
+ | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary}} | ||
+ | |Description=Returns the creation date and time of the specified file.}} | ||
+ | {{CGscriptMethods_Template|ReturnType=string|Name=GetDownloadPath|Parameters= | ||
+ | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary}} | ||
+ | |Description=Generates URL to download the file from.}} | ||
+ | {{CGscriptMethods_Template|ReturnType=string|Name=GetDownloadPath|Parameters= | ||
+ | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=downloadas|Description=Name of the file as presented to the user to save}} | ||
+ | |Description=Generates URL to download the file from.}} | ||
{{CGscriptMethods_Template|ReturnType=DateTime|Name=GetLastWriteTime|Parameters= | {{CGscriptMethods_Template|ReturnType=DateTime|Name=GetLastWriteTime|Parameters= | ||
− | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file | + | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary}} |
− | |Description=Returns the date and time the specified file | + | |Description=Returns the date and time the specified file was last written to.}} |
− | |||
{{CGscriptMethods_Template|ReturnType=array|Name=ReadAllLines|Parameters= | {{CGscriptMethods_Template|ReturnType=array|Name=ReadAllLines|Parameters= | ||
− | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file | + | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary}} |
− | |Description=Opens a text file, reads all lines of the file, and then closes the file.}} | + | |Description=Opens a text file, reads all lines of the file, and then closes the file.}} |
− | |||
{{CGscriptMethods_Template|ReturnType=string|Name=ReadAllText|Parameters= | {{CGscriptMethods_Template|ReturnType=string|Name=ReadAllText|Parameters= | ||
− | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file | + | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary}} |
− | |Description=Opens a text file, reads all lines of the file | + | |Description=Opens a text file, reads all lines of the file, and then closes the file.}} |
− | + | {{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}} | |
− | {{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}} | ||
− | |||
{{CGscriptMethods_Template|ReturnType=Empty|Name=WriteAllLines|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=WriteAllLines|Parameters= | ||
− | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file | + | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=content|Description=The content of the file}} |
− | + | |Description=Opens a text file, Writes all lines of the file, and then closes the file.}} | |
{{CGscriptMethods_Template|ReturnType=Empty|Name=WriteAllText|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=WriteAllText|Parameters= | ||
− | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file | + | {{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=content|Description=The content of the file}} |
− | + | |Description=Opens a text file, Writes all lines of the file, and then closes the file.}} | |
− | |Properties= {{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}} {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}} | + | |Properties= |
+ | {{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}} | ||
+ | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}} | ||
}} <br/> | }} <br/> | ||
Line 64: | Line 73: | ||
fileObj.ReadAllText("helloworld.txt", isTemp); // result : Hello World | fileObj.ReadAllText("helloworld.txt", isTemp); // result : Hello World | ||
fileObj.Delete("helloworld.txt", isTemp); // | fileObj.Delete("helloworld.txt", isTemp); // | ||
+ | </source> | ||
+ | |||
+ | <source lang="javascript"> | ||
+ | array a= {"Hello", "World"}; // array to write file | ||
+ | string b = "Hello World"; // string to write file | ||
+ | bool isTemp = false; // false is temporary file | ||
+ | |||
+ | object fileObj = Catglobe.File; // declare FileNameSpaceObject | ||
+ | string file_name=fileObj.GenerateRandomFilename(); | ||
+ | fileObj.WriteAllLines(file_name, isTemp, a); // write array a to file | ||
+ | print(fileObj.ReadAllLines(file_name, isTemp)); // result : {Hello,World} | ||
+ | print(fileObj.GetDownloadPath(file_name, isTemp)); // get download path | ||
+ | print(fileObj.GetCreationTime(file_name, isTemp)); // get creation time | ||
+ | print(fileObj.GetLastWriteTime(file_name, isTemp)); // get last write time | ||
+ | fileObj.WriteAllText(file_name, isTemp, b); // string b to file | ||
+ | fileObj.ReadAllText(file_name, isTemp); // result : Hello World | ||
+ | fileObj.Delete(file_name, isTemp); // | ||
</source> | </source> |
Revision as of 05:10, 16 November 2016
FileNamespace
The file namespace
Methods
- Empty AppendAllLines(string filename "Name of the file", bool isTemp "Is the file temporary", array content "The content of the file") - Opens a text file, Append all lines of the file, and then closes the file.
- Empty AppendAllText(string filename "Name of the file", bool isTemp "Is the file temporary", string content "The content of the file") - Opens a text file, Append all lines of the file, and then closes the file.
- Empty Delete(string filename "Name of the file", bool isTemp "Is the file temporary") - Deletes a file.
- string GenerateRandomFilename() - Provides a new random filename.
- DateTime GetCreationTime(string filename "Name of the file", bool isTemp "Is the file temporary") - Returns the creation date and time of the specified file.
- string GetDownloadPath(string filename "Name of the file", bool isTemp "Is the file temporary") - Generates URL to download the file from.
- string GetDownloadPath(string filename "Name of the file", bool isTemp "Is the file temporary", string downloadas "Name of the file as presented to the user to save") - Generates URL to download the file from.
- DateTime GetLastWriteTime(string filename "Name of the file", bool isTemp "Is the file temporary") - Returns the date and time the specified file was last written to.
- array ReadAllLines(string filename "Name of the file", bool isTemp "Is the file temporary") - Opens a text file, reads all lines of the file, and then closes the file.
- string ReadAllText(string filename "Name of the file", bool isTemp "Is the file temporary") - Opens a text file, reads all lines of the file, and then closes the file.
- string ToString() - The string representation of the object.
- Empty WriteAllLines(string filename "Name of the file", bool isTemp "Is the file temporary", array content "The content of the file") - Opens a text file, Writes all lines of the file, and then closes the file.
- Empty WriteAllText(string filename "Name of the file", bool isTemp "Is the file temporary", string content "The content of the file") - Opens a text file, Writes all lines of the file, and then closes the file.
Properties
- string ObjectTypeName { get; } - The name of the type of object.
- TypeInformation TypeInformation { get; } - Get information about this class.
Examples
array a= {"Hello", "World"}; // array to write file
string b = "Hello World"; // string to write file
bool isTemp = false; // false is temporary file
Catglobe.File.WriteAllLines("helloworld.txt", isTemp, a); // write array a to file
print(Catglobe.File.ReadAllLines("helloworld.txt", isTemp)); // result : {Hello,World}
print(Catglobe.File.GetDownloadPath("helloworld.txt", isTemp)); // get download path
print(Catglobe.File.GetCreationTime("helloworld.txt", isTemp)); // get creation time
print(Catglobe.File.GetLastWriteTime("helloworld.txt", isTemp)); // get last write time
Catglobe.File.WriteAllText("helloworld.txt", isTemp, b); // string b to file
Catglobe.File.ReadAllText("helloworld.txt", isTemp); // result : Hello World
array a= {"Hello", "World"}; // array to write file
string b = "Hello World"; // string to write file
bool isTemp = false; // false is temporary file
object fileObj = Catglobe.File; // declare FileNameSpaceObject
fileObj.WriteAllLines("helloworld.txt", isTemp, a); // write array a to file
print(fileObj.ReadAllLines("helloworld.txt", isTemp)); // result : {Hello,World}
print(fileObj.GetDownloadPath("helloworld.txt", isTemp)); // get download path
print(fileObj.GetCreationTime("helloworld.txt", isTemp)); // get creation time
print(fileObj.GetLastWriteTime("helloworld.txt", isTemp)); // get last write time
fileObj.WriteAllText("helloworld.txt", isTemp, b); // string b to file
fileObj.ReadAllText("helloworld.txt", isTemp); // result : Hello World
fileObj.Delete("helloworld.txt", isTemp); //
array a= {"Hello", "World"}; // array to write file
string b = "Hello World"; // string to write file
bool isTemp = false; // false is temporary file
object fileObj = Catglobe.File; // declare FileNameSpaceObject
string file_name=fileObj.GenerateRandomFilename();
fileObj.WriteAllLines(file_name, isTemp, a); // write array a to file
print(fileObj.ReadAllLines(file_name, isTemp)); // result : {Hello,World}
print(fileObj.GetDownloadPath(file_name, isTemp)); // get download path
print(fileObj.GetCreationTime(file_name, isTemp)); // get creation time
print(fileObj.GetLastWriteTime(file_name, isTemp)); // get last write time
fileObj.WriteAllText(file_name, isTemp, b); // string b to file
fileObj.ReadAllText(file_name, isTemp); // result : Hello World
fileObj.Delete(file_name, isTemp); //