Class RepoGenBaseFolder

Namespace

Ranorex.Core.Repository

Assembly

Ranorex.Core.dll

The base class for all generated repository folder classes.

public abstract class RepoGenBaseFolder : IReportMetadata

Inheritance

object

RepoGenBaseFolder

Implements

IReportMetadata

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

RepoGenBaseFolder(string, string, RepoGenBaseFolder, Duration, bool)

Initializes a new instance of the RepoGenBaseFolder class.

public RepoGenBaseFolder(string name, string basePath, RepoGenBaseFolder parentFolder, Duration folderSearchTimeout, bool useCache)

Parameters

name string

The name.

basePath string

The base path.

parentFolder RepoGenBaseFolder

The app folder.

folderSearchTimeout Duration

The folder search timeout.

useCache bool

if set to true use cache.

RepoGenBaseFolder(string, string, RepoGenBaseFolder, Duration, bool, string)

Initializes a new instance of the RepoGenBaseFolder class.

public RepoGenBaseFolder(string name, string basePath, RepoGenBaseFolder parentFolder, Duration folderSearchTimeout, bool useCache, string folderId)

Parameters

name string

The name.

basePath string

The base path.

parentFolder RepoGenBaseFolder

The app folder.

folderSearchTimeout Duration

The folder search timeout.

useCache bool

if set to true use cache.

folderId string

The id of the associated repository folder.

RepoGenBaseFolder(string, string, RepoGenBaseFolder, Duration, bool, string, string)

Initializes a new instance of the RepoGenBaseFolder class.

public RepoGenBaseFolder(string name, string basePath, RepoGenBaseFolder parentFolder, Duration folderSearchTimeout, bool useCache, string folderId, string imageResourceFileName)

Parameters

name string

The name.

basePath string

The base path.

parentFolder RepoGenBaseFolder

The app folder.

folderSearchTimeout Duration

The folder search timeout.

useCache bool

if set to true use cache.

folderId string

The id of the associated repository folder.

imageResourceFileName string

The image resource file name of the associated repository.

RepoGenBaseFolder(string, string, RepoGenBaseFolder, Duration, bool?, bool, string, string)

Initializes a new instance of the RepoGenBaseFolder class.

public RepoGenBaseFolder(string name, string basePath, RepoGenBaseFolder parentFolder, Duration folderSearchTimeout, bool? useEnsureVisible, bool useCache, string folderId, string imageResourceFileName)

Parameters

name string

The name.

basePath string

The base path.

parentFolder RepoGenBaseFolder

The app folder.

folderSearchTimeout Duration

The folder search timeout.

useEnsureVisible bool?

The value set to UseEnsureVisible of the adapter created for this folder.

useCache bool

if set to true use cache.

folderId string

The id of the associated repository folder.

imageResourceFileName string

The image resource file name of the associated repository.

Fields

_selfInfo

A RepoItemInfo instance containing information about this folder.

[CLSCompliant(false)]
protected readonly RepoItemInfo _selfInfo

Field Value

RepoItemInfo

Properties

AbsoluteBasePath

The absolute base path for the folder.

public RxPath AbsoluteBasePath { get; }

Property Value

RxPath

BasePath

The base path for the folder.

public RxPath BasePath { get; set; }

Property Value

RxPath

Remarks

This value should not be changed by user code.

BasePathString

The base path for the folder as string.

protected string BasePathString { get; }

Property Value

string

FolderElementValid

Gets a value indicating whether the cached folder element is still valid.

protected bool FolderElementValid { get; }

Property Value

bool

true if the cached folder element is valid; otherwise, false.

ParentFolder

The parent folder of this folder.

public RepoGenBaseFolder ParentFolder { get; }

Property Value

RepoGenBaseFolder

The parent folder of this folder or null if this folder does not have a parent.

SearchTimeout

Gets or sets the search timeout for the folder.

public Duration SearchTimeout { get; set; }

Property Value

Duration

The search timeout value.

UseCache

Gets or sets a value indicating whether to cache the element corresponding to this folder.

public bool UseCache { get; set; }

Property Value

bool

true if the folder should be cached; otherwise, false.

Methods

GetMetaInfos()

Returns a (non read-only!) dictionary of string key-value pairs specifying meta data for a report.

public IDictionary<string, string> GetMetaInfos()

Returns

IDictionary<string, string>

A (non read-only!) dictionary of strings.

ToString()

Returns a string representation, i.e. the Ranorex.Core.Repository.RepoGenBaseFolder.FullName, of this instance.

public override string ToString()

Returns

string

The Ranorex.Core.Repository.RepoGenBaseFolder.FullName of this instance.