Class FindReplaceRequest

Finds and replaces data in cells over a range, sheet, or all sheets.

Inheritance

object

FindReplaceRequest

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Sheets.v4.Data

Assembly: Google.Apis.Sheets.v4.dll

Syntax

public class FindReplaceRequest : IDirectResponseSchema

Properties

AllSheets

True to find/replace over all sheets.

Declaration

[JsonProperty("allSheets")]
public virtual bool? AllSheets { get; set; }

Property Value

Type	Description
bool?

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Find

The value to search.

Declaration

[JsonProperty("find")]
public virtual string Find { get; set; }

Property Value

Type	Description
string

IncludeFormulas

True if the search should include cells with formulas. False to skip cells with formulas.

Declaration

[JsonProperty("includeFormulas")]
public virtual bool? IncludeFormulas { get; set; }

Property Value

Type	Description
bool?

MatchCase

True if the search is case sensitive.

Declaration

[JsonProperty("matchCase")]
public virtual bool? MatchCase { get; set; }

Property Value

Type	Description
bool?

MatchEntireCell

True if the find value should match the entire cell.

Declaration

[JsonProperty("matchEntireCell")]
public virtual bool? MatchEntireCell { get; set; }

Property Value

Type	Description
bool?

Range

The range to find/replace over.

Declaration

[JsonProperty("range")]
public virtual GridRange Range { get; set; }

Property Value

Type	Description
GridRange

Replacement

The value to use as the replacement.

Declaration

[JsonProperty("replacement")]
public virtual string Replacement { get; set; }

Property Value

Type	Description
string

SearchByRegex

True if the find value is a regex. The regular expression and replacement should follow Java regex rules at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. The replacement string is allowed to refer to capturing groups. For example, if one cell has the contents "Google Sheets" and another has "Google Docs", then searching for "o.* (.*)" with a replacement of "$1 Rocks" would change the contents of the cells to "GSheets Rocks" and "GDocs Rocks" respectively.

Declaration

[JsonProperty("searchByRegex")]
public virtual bool? SearchByRegex { get; set; }

Property Value

Type	Description
bool?

SheetId

The sheet to find/replace over.

Declaration

[JsonProperty("sheetId")]
public virtual int? SheetId { get; set; }

Property Value

Type	Description
int?

Implements

IDirectResponseSchema