Difference between revisions of "FileNamespace class"

From Catglobe Wiki
Jump to: navigation, search
m (moved File Class to File class)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{CGscriptClass_Template |Name=<nowiki>File API</nowiki> |Description=<nowiki>Class of Write and Read File</nowiki> |Methods= {{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>GetCreationTime</nowiki>|Parameters=
+
{{CGscriptClass_Template
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file on server</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>}}
+
|Name=<nowiki>FileNamespace</nowiki>
|Description=<nowiki>Returns the creation date and time of the specified file on server.</nowiki>}}  
+
|Description=<nowiki>The file namespace</nowiki>
 
+
|InheritsFrom=object|Methods=
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AppendAllLines</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>content</nowiki>|Description=<nowiki>The content of the file</nowiki>}}
 +
|Description=<nowiki>Opens a text file, Append all lines of the file, and then closes the file.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AppendAllText</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>content</nowiki>|Description=<nowiki>The content of the file</nowiki>}}
 +
|Description=<nowiki>Opens a text file, Append all lines of the file, and then closes the file.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>AsHtmlBase64</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>}}
 +
|Description=<nowiki>Generates html base64 url.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>}}
 +
|Description=<nowiki>Deletes a file.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>GenerateRandomFilename</nowiki>|Description=<nowiki>Provides a new random filename.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>GetCreationTime</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>}}
 +
|Description=<nowiki>Returns the creation date and time of the specified file.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>GetDownloadPath</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>}}
 +
|Description=<nowiki>Generates URL to download the file from.</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>GetDownloadPath</nowiki>|Parameters=
 
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>GetDownloadPath</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file on server </nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>}}
+
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>downloadas</nowiki>|Description=<nowiki>Name of the file as presented to the user to save</nowiki>}}
|Description=<nowiki>Generates URL to download the file from site_address/Public/CgsFile.aspx?tempfile=filename&saveas=filename.</nowiki>}}  
+
|Description=<nowiki>Generates URL to download the file from.</nowiki>}}
 
 
 
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>GetLastWriteTime</nowiki>|Parameters=
 
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>GetLastWriteTime</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file on server.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>}}
+
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>}}
|Description=<nowiki>Returns the date and time the specified file on server was last written to.</nowiki>}}  
+
|Description=<nowiki>Returns the date and time the specified file was last written to.</nowiki>}}
 
 
 
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>ReadAllLines</nowiki>|Parameters=
 
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>ReadAllLines</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file on server</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>}}
+
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>}}
|Description=<nowiki>Opens a text file, reads all lines of the file, and then closes the file.</nowiki>}}  
+
|Description=<nowiki>Opens a text file, reads all lines of the file, and then closes the file.</nowiki>}}
 
 
 
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ReadAllText</nowiki>|Parameters=
 
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ReadAllText</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file on server</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>}}
+
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>}}
|Description=<nowiki>Opens a text file, reads all lines of the file (on server), and then closes the file.</nowiki>}}  
+
|Description=<nowiki>Opens a text file, reads all lines of the file, and then closes the file.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>WriteAllLines</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>content</nowiki>|Description=<nowiki>The content of the file</nowiki>}}
 +
|Description=<nowiki>Opens a text file, Writes all lines of the file, and then closes the file.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>WriteAllText</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>content</nowiki>|Description=<nowiki>The content of the file</nowiki>}}
 +
|Description=<nowiki>Opens a text file, Writes all lines of the file, and then closes the file.</nowiki>}}
 +
|Properties=
 +
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 +
}}
  
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+
==== <span style="color: rgb(165, 42, 42)">'''Examples'''</span><br/>&nbsp;<br/> ====
  
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>WriteAllLines</nowiki>|Parameters=
+
<source lang="javascript">
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file on server</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>content</nowiki>|Description=<nowiki>The content of the file</nowiki>}}|Description=<nowiki>Opens a text file, Writes all lines of the file, Saves, and then closes the file on server. If there is duplicated file name on server, it will be written on. (Content of last file loses)</nowiki>}}
+
array a= {"Hello", "World"}; // array to write file
 +
string b = "Hello World"; // string to write file
 +
bool isTemp = false; // false is temporary file
  
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>WriteAllText</nowiki>|Parameters=
+
Catglobe.File.WriteAllLines("helloworld.txt", isTemp, a); // write array a to file
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file on server.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>content</nowiki>|Description=<nowiki>The content of the file</nowiki>}}|Description=<nowiki>Opens a text file, Writes all lines of the file, Saves, and then closes the file on server. If there is duplicated file name on server, it will be written on. (Content of last file loses).</nowiki>}}
+
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
 +
</source>
  
|Properties= {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+
<source lang="javascript">
}}&nbsp;<br>&nbsp;<br>
+
array a= {"Hello", "World"}; // array to write file
 +
string b = "Hello World"; // string to write file
 +
bool isTemp = false; // false is temporary file
  
==== <span style="color: rgb(165, 42, 42);">'''Examples'''</span><br>&nbsp;  ====
+
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); //
 +
</source>
  
 
<source lang="javascript">
 
<source lang="javascript">
 
array a= {"Hello", "World"}; // array to write file
 
array a= {"Hello", "World"}; // array to write file
string b = "Hello World";   // string to write file
+
string b = "Hello World"; // string to write file
bool isTemp = false;         // false is temporary 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
 
</source> <br>
 
  
[[Category:Classes]]
+
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>

Latest revision as of 07:56, 2 July 2020

FileNamespace



The file namespace

Parent class

Inherits from object

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.
  • string AsHtmlBase64(string filename "Name of the file", bool isTemp "Is the file temporary") - Generates html base64 url.
  • 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.
  • (From object) 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.
  • (From 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); //