Folder

Overview

Class for accessing folders on the file system.

Location

  • Reference: Island.fx
  • Namespace: RemObjects.Elements.System
  • Platforms: Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS, watchOS Simulator, Windows
  • Ancestry: BaseFile | Folder

 

constructor    (declared in Object)

Default constructor.

 

constructor

 

Folder()

 

init()

 

Folder()

constructor (not nullable String)

constructor

 

constructor(aFullName: not nullable String)

 

Folder(String! aFullName)

 

init(_ aFullName: String)

 

Folder(String! aFullName)

Parameters:

  • aFullName: Full name of the folder.

CreateFile

Creates a new file instance.

 

method CreateFile(FileName: String; FailIfExists: Boolean): File

 

File CreateFile(String FileName, Boolean FailIfExists)

 

func CreateFile(_ FileName: String, _ FailIfExists: Boolean) -> File

 

File CreateFile(String FileName, Boolean FailIfExists)

Parameters:

  • FileName: filename
  • FailIfExists: if true fails if the file already exists.

CreateFolder

Creates a new folder.

 

class method CreateFolder(FolderName: String; FailIfExists: Boolean): Folder

 

static Folder CreateFolder(String FolderName, Boolean FailIfExists)

 

static func CreateFolder(_ FolderName: String, _ FailIfExists: Boolean) -> Folder

 

static Folder CreateFolder(String FolderName, Boolean FailIfExists)

Parameters:

  • FolderName: Full name of the folder.
  • FailIfExists: if true fails if the folder already exists.

CreateSubfolder

Creates a subfolder.

 

method CreateSubfolder(SubfolderName: String; FailIfExists: Boolean): Folder

 

Folder CreateSubfolder(String SubfolderName, Boolean FailIfExists)

 

func CreateSubfolder(_ SubfolderName: String, _ FailIfExists: Boolean) -> Folder

 

Folder CreateSubfolder(String SubfolderName, Boolean FailIfExists)

Parameters:

  • SubfolderName: Name of the folder
  • FailIfExists: if true fails if the folder already exists.

DateAccessed    (declared in BaseFile)

Date this file system item was last accessed.

 

property DateAccessed: DateTime read;

 

DateTime DateAccessed { get; }

 

var DateAccessed: DateTime { get{} }

 

DateTime DateAccessed { __get; }

DateCreated    (declared in BaseFile)

Date this filesystem element was created.

 

property DateCreated: DateTime read;

 

DateTime DateCreated { get; }

 

var DateCreated: DateTime { get{} }

 

DateTime DateCreated { __get; }

DateModified    (declared in BaseFile)

Date this filesystem element was last modif

 

property DateModified: DateTime read;

 

DateTime DateModified { get; }

 

var DateModified: DateTime { get{} }

 

DateTime DateModified { __get; }

Delete  override virtual

Delete this folder.

 

method Delete

 

void Delete()

 

func Delete()

 

void Delete()

Delete (String) Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows

 

class method Delete(aFolder: String)

 

static void Delete(String aFolder)

 

static func Delete(_ aFolder: String)

 

static void Delete(String aFolder)

Parameters:

  • aFolder:

Equals  virtual    (declared in Object)

Returns true if the target object matches this one, by default compares the reference.

 

method Equals(obj: Object): Boolean

 

Boolean Equals(Object obj)

 

func Equals(_ obj: Object) -> Boolean

 

Boolean Equals(Object obj)

Parameters:

  • obj: the reference to compare this with.

Exists  override virtual

Check if this folder exists.

 

method Exists: Boolean

 

Boolean Exists()

 

func Exists() -> Boolean

 

Boolean Exists()

Exists (String): Boolean Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows

 

class method Exists(aFolder: String): Boolean

 

static Boolean Exists(String aFolder)

 

static func Exists(_ aFolder: String) -> Boolean

 

static Boolean Exists(String aFolder)

Parameters:

  • aFolder:

Extension    (declared in BaseFile)

Returns the extension of this file/folder preceded with a .

 

property Extension: not nullable String read;

 

String! Extension { get; }

 

var Extension: String { get{} }

 

String! Extension { __get; }

Finalize  protected virtual    (declared in Object)

Finalizer implementation. If not overriden it's not called at all, the runtime checks if there is an override before calling a finalizer.

 

method Finalize

 

void Finalize()

 

func Finalize()

 

void Finalize()

FullName    (declared in BaseFile)

Returns the full name including path.

 

property FullName: not nullable String read;

 

String! FullName { get; }

 

var FullName: String { get{} }

 

String! FullName { __get; }

GetFile

Gets a file in this folder.

 

method GetFile(FileName: String): File

 

File GetFile(String FileName)

 

func GetFile(_ FileName: String) -> File

 

File GetFile(String FileName)

Parameters:

  • FileName: Name of the file to look for

GetFiles

Gets a list of all files in this folder.

 

// watchOS-arm64
method GetFiles: not nullable List<File>
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
method GetFiles: not nullable ImmutableList<File>

 

// watchOS-arm64
List<File>! GetFiles()
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
ImmutableList<File>! GetFiles()

 

// watchOS-arm64
func GetFiles() -> List<File>
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
func GetFiles() -> ImmutableList<File>

 

// watchOS-arm64
List<File>! GetFiles()
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
ImmutableList<File>! GetFiles()

GetHandle  protected    (declared in BaseFile) Windows

Returns a handle to this file.

 

method GetHandle: HANDLE

 

HANDLE GetHandle()

 

func GetHandle() -> HANDLE

 

HANDLE GetHandle()

GetHashCode  virtual    (declared in Object)

Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.

 

method GetHashCode: Int32

 

Int32 GetHashCode()

 

func GetHashCode() -> Int32

 

Int32 GetHashCode()

GetSubfolders

Gets a list of all subfolders.

 

// watchOS-arm64
method GetSubfolders: not nullable List<Folder>
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
method GetSubfolders: not nullable ImmutableList<Folder>

 

// watchOS-arm64
List<Folder>! GetSubfolders()
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
ImmutableList<Folder>! GetSubfolders()

 

// watchOS-arm64
func GetSubfolders() -> List<Folder>
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
func GetSubfolders() -> ImmutableList<Folder>

 

// watchOS-arm64
List<Folder>! GetSubfolders()
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
ImmutableList<Folder>! GetSubfolders()

GetType    (declared in Object)

Returns the actual type of this class

 

method GetType: Type

 

Type GetType()

 

func GetType() -> Type

 

Type GetType()

Name    (declared in BaseFile)

Returns the name without path.

 

property Name: not nullable String read;

 

String! Name { get; }

 

var Name: String { get{} }

 

String! Name { __get; }

ReferenceEquals    (declared in Object)

Compares two references for equivalence (even if they have an equals operator)

 

class method ReferenceEquals(a: Object; b: Object): Boolean

 

static Boolean ReferenceEquals(Object a, Object b)

 

static func ReferenceEquals(_ a: Object, _ b: Object) -> Boolean

 

static Boolean ReferenceEquals(Object a, Object b)

Parameters:

  • a: left value
  • b: right value

Rename

Rename a folder.

 

method Rename(NewName: String): Folder

 

Folder Rename(String NewName)

 

func Rename(_ NewName: String) -> Folder

 

Folder Rename(String NewName)

Parameters:

  • NewName: new name for this folder; returns the new folder instance.

Separator

Separator for folder names in a path.

 

class property Separator: Char read;

 

class Char Separator { get; }

 

static var Separator: Char { get{} }

 

class Char Separator { __get; }

ToString  virtual    (declared in Object)

Gets the string representation of this method.

 

method ToString: String

 

String ToString()

 

func ToString() -> String

 

String ToString()

 

DateAccessed    (declared in BaseFile)

Date this file system item was last accessed.

 

property DateAccessed: DateTime read;

 

DateTime DateAccessed { get; }

 

var DateAccessed: DateTime { get{} }

 

DateTime DateAccessed { __get; }

DateCreated    (declared in BaseFile)

Date this filesystem element was created.

 

property DateCreated: DateTime read;

 

DateTime DateCreated { get; }

 

var DateCreated: DateTime { get{} }

 

DateTime DateCreated { __get; }

DateModified    (declared in BaseFile)

Date this filesystem element was last modif

 

property DateModified: DateTime read;

 

DateTime DateModified { get; }

 

var DateModified: DateTime { get{} }

 

DateTime DateModified { __get; }

Extension    (declared in BaseFile)

Returns the extension of this file/folder preceded with a .

 

property Extension: not nullable String read;

 

String! Extension { get; }

 

var Extension: String { get{} }

 

String! Extension { __get; }

FullName    (declared in BaseFile)

Returns the full name including path.

 

property FullName: not nullable String read;

 

String! FullName { get; }

 

var FullName: String { get{} }

 

String! FullName { __get; }

Name    (declared in BaseFile)

Returns the name without path.

 

property Name: not nullable String read;

 

String! Name { get; }

 

var Name: String { get{} }

 

String! Name { __get; }

Separator

Separator for folder names in a path.

 

class property Separator: Char read;

 

class Char Separator { get; }

 

static var Separator: Char { get{} }

 

class Char Separator { __get; }

 

CreateFolder

Creates a new folder.

 

class method CreateFolder(FolderName: String; FailIfExists: Boolean): Folder

 

static Folder CreateFolder(String FolderName, Boolean FailIfExists)

 

static func CreateFolder(_ FolderName: String, _ FailIfExists: Boolean) -> Folder

 

static Folder CreateFolder(String FolderName, Boolean FailIfExists)

Parameters:

  • FolderName: Full name of the folder.
  • FailIfExists: if true fails if the folder already exists.

Delete (String) Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows

 

class method Delete(aFolder: String)

 

static void Delete(String aFolder)

 

static func Delete(_ aFolder: String)

 

static void Delete(String aFolder)

Parameters:

  • aFolder:

Exists (String): Boolean Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows

 

class method Exists(aFolder: String): Boolean

 

static Boolean Exists(String aFolder)

 

static func Exists(_ aFolder: String) -> Boolean

 

static Boolean Exists(String aFolder)

Parameters:

  • aFolder:

ReferenceEquals    (declared in Object)

Compares two references for equivalence (even if they have an equals operator)

 

class method ReferenceEquals(a: Object; b: Object): Boolean

 

static Boolean ReferenceEquals(Object a, Object b)

 

static func ReferenceEquals(_ a: Object, _ b: Object) -> Boolean

 

static Boolean ReferenceEquals(Object a, Object b)

Parameters:

  • a: left value
  • b: right value

 

constructor    (declared in Object)

Default constructor.

 

constructor

 

Folder()

 

init()

 

Folder()

constructor (not nullable String)

constructor

 

constructor(aFullName: not nullable String)

 

Folder(String! aFullName)

 

init(_ aFullName: String)

 

Folder(String! aFullName)

Parameters:

  • aFullName: Full name of the folder.

CreateFile

Creates a new file instance.

 

method CreateFile(FileName: String; FailIfExists: Boolean): File

 

File CreateFile(String FileName, Boolean FailIfExists)

 

func CreateFile(_ FileName: String, _ FailIfExists: Boolean) -> File

 

File CreateFile(String FileName, Boolean FailIfExists)

Parameters:

  • FileName: filename
  • FailIfExists: if true fails if the file already exists.

CreateSubfolder

Creates a subfolder.

 

method CreateSubfolder(SubfolderName: String; FailIfExists: Boolean): Folder

 

Folder CreateSubfolder(String SubfolderName, Boolean FailIfExists)

 

func CreateSubfolder(_ SubfolderName: String, _ FailIfExists: Boolean) -> Folder

 

Folder CreateSubfolder(String SubfolderName, Boolean FailIfExists)

Parameters:

  • SubfolderName: Name of the folder
  • FailIfExists: if true fails if the folder already exists.

Delete  override virtual

Delete this folder.

 

method Delete

 

void Delete()

 

func Delete()

 

void Delete()

Equals  virtual    (declared in Object)

Returns true if the target object matches this one, by default compares the reference.

 

method Equals(obj: Object): Boolean

 

Boolean Equals(Object obj)

 

func Equals(_ obj: Object) -> Boolean

 

Boolean Equals(Object obj)

Parameters:

  • obj: the reference to compare this with.

Exists  override virtual

Check if this folder exists.

 

method Exists: Boolean

 

Boolean Exists()

 

func Exists() -> Boolean

 

Boolean Exists()

Finalize  protected virtual    (declared in Object)

Finalizer implementation. If not overriden it's not called at all, the runtime checks if there is an override before calling a finalizer.

 

method Finalize

 

void Finalize()

 

func Finalize()

 

void Finalize()

GetFile

Gets a file in this folder.

 

method GetFile(FileName: String): File

 

File GetFile(String FileName)

 

func GetFile(_ FileName: String) -> File

 

File GetFile(String FileName)

Parameters:

  • FileName: Name of the file to look for

GetFiles

Gets a list of all files in this folder.

 

// watchOS-arm64
method GetFiles: not nullable List<File>
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
method GetFiles: not nullable ImmutableList<File>

 

// watchOS-arm64
List<File>! GetFiles()
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
ImmutableList<File>! GetFiles()

 

// watchOS-arm64
func GetFiles() -> List<File>
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
func GetFiles() -> ImmutableList<File>

 

// watchOS-arm64
List<File>! GetFiles()
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
ImmutableList<File>! GetFiles()

GetHandle  protected    (declared in BaseFile) Windows

Returns a handle to this file.

 

method GetHandle: HANDLE

 

HANDLE GetHandle()

 

func GetHandle() -> HANDLE

 

HANDLE GetHandle()

GetHashCode  virtual    (declared in Object)

Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.

 

method GetHashCode: Int32

 

Int32 GetHashCode()

 

func GetHashCode() -> Int32

 

Int32 GetHashCode()

GetSubfolders

Gets a list of all subfolders.

 

// watchOS-arm64
method GetSubfolders: not nullable List<Folder>
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
method GetSubfolders: not nullable ImmutableList<Folder>

 

// watchOS-arm64
List<Folder>! GetSubfolders()
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
ImmutableList<Folder>! GetSubfolders()

 

// watchOS-arm64
func GetSubfolders() -> List<Folder>
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
func GetSubfolders() -> ImmutableList<Folder>

 

// watchOS-arm64
List<Folder>! GetSubfolders()
// Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
ImmutableList<Folder>! GetSubfolders()

GetType    (declared in Object)

Returns the actual type of this class

 

method GetType: Type

 

Type GetType()

 

func GetType() -> Type

 

Type GetType()

Rename

Rename a folder.

 

method Rename(NewName: String): Folder

 

Folder Rename(String NewName)

 

func Rename(_ NewName: String) -> Folder

 

Folder Rename(String NewName)

Parameters:

  • NewName: new name for this folder; returns the new folder instance.

ToString  virtual    (declared in Object)

Gets the string representation of this method.

 

method ToString: String

 

String ToString()

 

func ToString() -> String

 

String ToString()