Class RepositoryEntry

Namespace

Ranorex.Core.Repository

Assembly

Ranorex.Core.dll

public abstract class RepositoryEntry

Inheritance

object

RepositoryEntry

Derived

RepositoryFolder

RepositoryItem

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

RepositoryEntry(ElementRepository, RepositoryFolder)

protected RepositoryEntry(ElementRepository owner, RepositoryFolder parentFolder)

Parameters

owner ElementRepository

parentFolder RepositoryFolder

RepositoryEntry(ElementRepository, string, string, bool?, RepositoryFolder)

protected RepositoryEntry(ElementRepository owner, string name, string capabilityName, bool? useEnsureVisible, RepositoryFolder parentFolder)

Parameters

owner ElementRepository

name string

capabilityName string

useEnsureVisible bool?

parentFolder RepositoryFolder

RepositoryEntry(ElementRepository, string, string, bool?, RepositoryFolder, SortedList<string, CompressedImage>, IList<string>)

protected RepositoryEntry(ElementRepository owner, string name, string capabilityName, bool? useEnsureVisible, RepositoryFolder parentFolder, SortedList<string, CompressedImage> images, IList<string> additionalCapabilities)

Parameters

owner ElementRepository

name string

capabilityName string

useEnsureVisible bool?

parentFolder RepositoryFolder

images SortedList<string, CompressedImage>

additionalCapabilities IList<string>

RepositoryEntry(XmlNode, ElementRepository, RepositoryFolder)

protected RepositoryEntry(XmlNode node, ElementRepository owner, RepositoryFolder parentFolder)

Parameters

node XmlNode

owner ElementRepository

parentFolder RepositoryFolder

Properties

AbsolutePath

[Browsable(false)]
public abstract RxPath AbsolutePath { get; set; }

Property Value

RxPath

AdditionalCapabilities

[Browsable(false)]
public IList<string> AdditionalCapabilities { get; }

Property Value

IList<string>

CapabilityName

[Browsable(false)]
public string CapabilityName { get; }

Property Value

string

CapabilityNameOverride

[TypeConverter(typeof(RepositoryEntry.AdapterTypeTypeConverter))]
public string CapabilityNameOverride { get; set; }

Property Value

string

Comment

public string Comment { get; set; }

Property Value

string

EffectiveTimeout

public virtual Duration EffectiveTimeout { get; }

Property Value

Duration

FullName

[Browsable(false)]
public string FullName { get; }

Property Value

string

HasReferenceImage

[Browsable(false)]
public bool HasReferenceImage { get; }

Property Value

bool

Id

[Browsable(false)]
public Guid Id { get; set; }

Property Value

Guid

Images

[Browsable(false)]
public IDictionary<string, CompressedImage> Images { get; }

Property Value

IDictionary<string, CompressedImage>

IsNew

[Browsable(false)]
public bool IsNew { get; set; }

Property Value

bool

LiveElement

public virtual Element LiveElement { get; set; }

Property Value

Element

Name

public string Name { get; set; }

Property Value

string

Owner

[Browsable(false)]
public virtual ElementRepository Owner { get; set; }

Property Value

ElementRepository

ParentFolder

[Browsable(false)]
public RepositoryFolder ParentFolder { get; }

Property Value

RepositoryFolder

RefImageId

[Browsable(false)]
public Guid RefImageId { get; }

Property Value

Guid

ReferencePath

[Browsable(false)]
public string ReferencePath { get; set; }

Property Value

string

RobustPath

[Browsable(false)]
public abstract RxPath RobustPath { get; set; }

Property Value

RxPath

RobustPathOverride

[Browsable(false)]
public abstract string RobustPathOverride { get; set; }

Property Value

string

SearchTimeout

public virtual Duration SearchTimeout { get; set; }

Property Value

Duration

UseEnsureVisible

[TypeConverter(typeof(NullableBoolTypeConverter))]
public virtual bool? UseEnsureVisible { get; set; }

Property Value

bool?

Methods

AppendImage(string, CompressedImage, bool)

public KeyValuePair<string, CompressedImage> AppendImage(string name, CompressedImage screenShot, bool makeUniqueName)

Parameters

name string

screenShot CompressedImage

makeUniqueName bool

Returns

KeyValuePair<string, CompressedImage>

AppendImage(string, Bitmap, bool)

public KeyValuePair<string, CompressedImage> AppendImage(string name, Bitmap screenShot, bool makeUniqueName)

Parameters

name string

screenShot Bitmap

makeUniqueName bool

Returns

KeyValuePair<string, CompressedImage>

AppendImageChecked(string, CompressedImage, bool, out bool)

public KeyValuePair<string, CompressedImage> AppendImageChecked(string name, CompressedImage screenShot, bool makeUniqueName, out bool wasDuplicate)

Parameters

name string

screenShot CompressedImage

makeUniqueName bool

wasDuplicate bool

Returns

KeyValuePair<string, CompressedImage>

AppendImageChecked(string, Bitmap, bool, out bool)

public KeyValuePair<string, CompressedImage> AppendImageChecked(string name, Bitmap screenShot, bool makeUniqueName, out bool wasDuplicate)

Parameters

name string

screenShot Bitmap

makeUniqueName bool

wasDuplicate bool

Returns

KeyValuePair<string, CompressedImage>

GetBestRootedParentFolder()

public RootedRepositoryFolder GetBestRootedParentFolder()

Returns

RootedRepositoryFolder

GetBestRootedParentFolderOrSelf()

public RootedRepositoryFolder GetBestRootedParentFolderOrSelf()

Returns

RootedRepositoryFolder

GetContainingAppFolder()

public virtual RepositoryAppFolder GetContainingAppFolder()

Returns

RepositoryAppFolder

GetOwnerAppFolderPath()

public virtual RxPath GetOwnerAppFolderPath()

Returns

RxPath

GetReferenceScreenshot()

public CompressedImage GetReferenceScreenshot()

Returns

CompressedImage

GetXmlNode(XmlNode)

public XmlNode GetXmlNode(XmlNode parent)

Parameters

parent XmlNode

Returns

XmlNode

GetXmlNode(XmlNode, bool, RefScreenshotStoreMode)

public virtual XmlNode GetXmlNode(XmlNode parent, bool withTestImages, RefScreenshotStoreMode refScMode)

Parameters

parent XmlNode

withTestImages bool

refScMode RefScreenshotStoreMode

Returns

XmlNode

RemoveImage(string)

public void RemoveImage(string name)

Parameters

name string

SetReferenceImage(CompressedImage)

public void SetReferenceImage(CompressedImage refImg)

Parameters

refImg CompressedImage

SetReferenceImage(Bitmap)

public void SetReferenceImage(Bitmap refImg)

Parameters

refImg Bitmap

ToString()

public override string ToString()

Returns

string

UpdateCapabilityName(RxPath)

protected void UpdateCapabilityName(RxPath path)

Parameters

path RxPath