Path

Overview

Filesystem Path utilities.

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

 

constructor    (declared in Object)

Default constructor.

 

constructor

 

Path()

 

init()

 

Path()

 

Sub New()

ChangeExtension

Change the extension of a filename, replacing it with the new one.

 

class method ChangeExtension(FileName: not nullable String; NewExtension: nullable String): not nullable String

 

static String! ChangeExtension(String! FileName, String? NewExtension)

 

static func ChangeExtension(_ FileName: String, _ NewExtension: String?) -> String

 

static String ChangeExtension(String FileName, String NewExtension)

 

Shared Function ChangeExtension(FileName As String, NewExtension As String?) As String

Parameters:

  • FileName:
  • NewExtension:

Combine (not nullable String, not nullable String): not nullable String

Combine two paths, adds them together with the system's path seperator.

 

class method Combine(BasePath: not nullable String; Path: not nullable String): not nullable String

 

static String! Combine(String! BasePath, String! Path)

 

static func Combine(_ BasePath: String, _ Path: String) -> String

 

static String Combine(String BasePath, String Path)

 

Shared Function Combine(BasePath As String, Path As String) As String

Parameters:

  • BasePath:
  • Path:

Combine (not nullable String, not nullable String, not nullable String): not nullable String

Combine two paths, adds them together with the system's path seperator.

 

class method Combine(BasePath: not nullable String; Path1: not nullable String; Path2: not nullable String): not nullable String

 

static String! Combine(String! BasePath, String! Path1, String! Path2)

 

static func Combine(_ BasePath: String, _ Path1: String, _ Path2: String) -> String

 

static String Combine(String BasePath, String Path1, String Path2)

 

Shared Function Combine(BasePath As String, Path1 As String, Path2 As String) As String

Parameters:

  • BasePath:
  • Path1:
  • Path2:

DirectorySeparatorChar

Directory seperator; generally '\' on Windows, and '/' on others.

 

class property DirectorySeparatorChar: Char read;

 

class Char DirectorySeparatorChar { get; }

 

static var DirectorySeparatorChar: Char { get{} }

 

class Char DirectorySeparatorChar { __get; }

 

Shared ReadOnly Property DirectorySeparatorChar() As Char

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)

 

Function Equals(obj As Object) As Boolean

Parameters:

  • obj: the reference to compare this with.

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()

 

Sub Finalize()

GetExtension

Returns the extension of a filename, including the .

 

class method GetExtension(FileName: not nullable String): not nullable String

 

static String! GetExtension(String! FileName)

 

static func GetExtension(_ FileName: String) -> String

 

static String GetExtension(String FileName)

 

Shared Function GetExtension(FileName As String) As String

Parameters:

  • FileName:

GetFileName

Returns the filename without directory.

 

class method GetFileName(FileName: not nullable String): not nullable String

 

static String! GetFileName(String! FileName)

 

static func GetFileName(_ FileName: String) -> String

 

static String GetFileName(String FileName)

 

Shared Function GetFileName(FileName As String) As String

Parameters:

  • FileName:

GetFileNameWithoutExtension

Returns the filename without directory and extension.

 

class method GetFileNameWithoutExtension(FileName: not nullable String): not nullable String

 

static String! GetFileNameWithoutExtension(String! FileName)

 

static func GetFileNameWithoutExtension(_ FileName: String) -> String

 

static String GetFileNameWithoutExtension(String FileName)

 

Shared Function GetFileNameWithoutExtension(FileName As String) As String

Parameters:

  • FileName:

GetFullPath

Gets the full absolute path from a relative path.

 

class method GetFullPath(RelativePath: not nullable String): not nullable String

 

static String! GetFullPath(String! RelativePath)

 

static func GetFullPath(_ RelativePath: String) -> String

 

static String GetFullPath(String RelativePath)

 

Shared Function GetFullPath(RelativePath As String) As String

Parameters:

  • RelativePath:

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()

 

Function GetHashCode() As Int32

GetParentDirectory

Returns the paraent directory.

 

class method GetParentDirectory(FileName: not nullable String): nullable String

 

static String? GetParentDirectory(String! FileName)

 

static func GetParentDirectory(_ FileName: String) -> String?

 

static String GetParentDirectory(String FileName)

 

Shared Function GetParentDirectory(FileName As String) As String?

Parameters:

  • FileName:

GetType    (declared in Object)

Returns the actual type of this class

 

method GetType: Type

 

Type GetType()

 

func GetType() -> Type

 

Type GetType()

 

Function GetType() As Type

ListSeparator

Returns the system's list seperator; generally ; on windows and : on posix.

 

class property ListSeparator: Char read;

 

class Char ListSeparator { get; }

 

static var ListSeparator: Char { get{} }

 

class Char ListSeparator { __get; }

 

Shared ReadOnly Property ListSeparator() As Char

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)

 

Shared Function ReferenceEquals(a As Object, b As Object) As Boolean

Parameters:

  • a: left value
  • b: right value

ToString  virtual    (declared in Object)

Gets the string representation of this method.

 

method ToString: String

 

String ToString()

 

func ToString() -> String

 

String ToString()

 

Function ToString() As String

 

DirectorySeparatorChar

Directory seperator; generally '\' on Windows, and '/' on others.

 

class property DirectorySeparatorChar: Char read;

 

class Char DirectorySeparatorChar { get; }

 

static var DirectorySeparatorChar: Char { get{} }

 

class Char DirectorySeparatorChar { __get; }

 

Shared ReadOnly Property DirectorySeparatorChar() As Char

ListSeparator

Returns the system's list seperator; generally ; on windows and : on posix.

 

class property ListSeparator: Char read;

 

class Char ListSeparator { get; }

 

static var ListSeparator: Char { get{} }

 

class Char ListSeparator { __get; }

 

Shared ReadOnly Property ListSeparator() As Char

 

ChangeExtension

Change the extension of a filename, replacing it with the new one.

 

class method ChangeExtension(FileName: not nullable String; NewExtension: nullable String): not nullable String

 

static String! ChangeExtension(String! FileName, String? NewExtension)

 

static func ChangeExtension(_ FileName: String, _ NewExtension: String?) -> String

 

static String ChangeExtension(String FileName, String NewExtension)

 

Shared Function ChangeExtension(FileName As String, NewExtension As String?) As String

Parameters:

  • FileName:
  • NewExtension:

Combine (not nullable String, not nullable String): not nullable String

Combine two paths, adds them together with the system's path seperator.

 

class method Combine(BasePath: not nullable String; Path: not nullable String): not nullable String

 

static String! Combine(String! BasePath, String! Path)

 

static func Combine(_ BasePath: String, _ Path: String) -> String

 

static String Combine(String BasePath, String Path)

 

Shared Function Combine(BasePath As String, Path As String) As String

Parameters:

  • BasePath:
  • Path:

Combine (not nullable String, not nullable String, not nullable String): not nullable String

Combine two paths, adds them together with the system's path seperator.

 

class method Combine(BasePath: not nullable String; Path1: not nullable String; Path2: not nullable String): not nullable String

 

static String! Combine(String! BasePath, String! Path1, String! Path2)

 

static func Combine(_ BasePath: String, _ Path1: String, _ Path2: String) -> String

 

static String Combine(String BasePath, String Path1, String Path2)

 

Shared Function Combine(BasePath As String, Path1 As String, Path2 As String) As String

Parameters:

  • BasePath:
  • Path1:
  • Path2:

GetExtension

Returns the extension of a filename, including the .

 

class method GetExtension(FileName: not nullable String): not nullable String

 

static String! GetExtension(String! FileName)

 

static func GetExtension(_ FileName: String) -> String

 

static String GetExtension(String FileName)

 

Shared Function GetExtension(FileName As String) As String

Parameters:

  • FileName:

GetFileName

Returns the filename without directory.

 

class method GetFileName(FileName: not nullable String): not nullable String

 

static String! GetFileName(String! FileName)

 

static func GetFileName(_ FileName: String) -> String

 

static String GetFileName(String FileName)

 

Shared Function GetFileName(FileName As String) As String

Parameters:

  • FileName:

GetFileNameWithoutExtension

Returns the filename without directory and extension.

 

class method GetFileNameWithoutExtension(FileName: not nullable String): not nullable String

 

static String! GetFileNameWithoutExtension(String! FileName)

 

static func GetFileNameWithoutExtension(_ FileName: String) -> String

 

static String GetFileNameWithoutExtension(String FileName)

 

Shared Function GetFileNameWithoutExtension(FileName As String) As String

Parameters:

  • FileName:

GetFullPath

Gets the full absolute path from a relative path.

 

class method GetFullPath(RelativePath: not nullable String): not nullable String

 

static String! GetFullPath(String! RelativePath)

 

static func GetFullPath(_ RelativePath: String) -> String

 

static String GetFullPath(String RelativePath)

 

Shared Function GetFullPath(RelativePath As String) As String

Parameters:

  • RelativePath:

GetParentDirectory

Returns the paraent directory.

 

class method GetParentDirectory(FileName: not nullable String): nullable String

 

static String? GetParentDirectory(String! FileName)

 

static func GetParentDirectory(_ FileName: String) -> String?

 

static String GetParentDirectory(String FileName)

 

Shared Function GetParentDirectory(FileName As String) As String?

Parameters:

  • FileName:

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)

 

Shared Function ReferenceEquals(a As Object, b As Object) As Boolean

Parameters:

  • a: left value
  • b: right value

 

constructor    (declared in Object)

Default constructor.

 

constructor

 

Path()

 

init()

 

Path()

 

Sub New()

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)

 

Function Equals(obj As Object) As Boolean

Parameters:

  • obj: the reference to compare this with.

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()

 

Sub Finalize()

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()

 

Function GetHashCode() As Int32

GetType    (declared in Object)

Returns the actual type of this class

 

method GetType: Type

 

Type GetType()

 

func GetType() -> Type

 

Type GetType()

 

Function GetType() As Type

ToString  virtual    (declared in Object)

Gets the string representation of this method.

 

method ToString: String

 

String ToString()

 

func ToString() -> String

 

String ToString()

 

Function ToString() As String