C# Class SubLib.Core.Search.SubtitleSearchOptions

Represents the options used during a search operation.
Mostra file Open project: GNOME/gnome-subtitles Class Usage Examples

Public Methods

Method Description
SubtitleSearchOptions ( Regex regex, SubtitleTextType textType, int startSubtitle, int startIndex, bool wrap, bool backwards ) : SubLib.Core.Domain

Creates a new instance of the SubtitleSearchOptions class.

The newline character (\n) is used as lineBreak.

SubtitleSearchOptions ( Regex regex, SubtitleTextType textType, string lineBreak, int startSubtitle, int startIndex, bool wrap, bool backwards ) : SubLib.Core.Domain

Creates a new instance of the SubtitleSearchOptions class.

Method Details

SubtitleSearchOptions() public method

Creates a new instance of the SubtitleSearchOptions class.
The newline character (\n) is used as lineBreak.
public SubtitleSearchOptions ( Regex regex, SubtitleTextType textType, int startSubtitle, int startIndex, bool wrap, bool backwards ) : SubLib.Core.Domain
regex System.Text.RegularExpressions.Regex The regular expression to use when searching. It must be created with /// to perform a case-insensitive search.
textType SubtitleTextType The type of text content the search is started at.
startSubtitle int The zero-based number of the subtitle to start the search at.
startIndex int The zero-based position within the startSubtitle to start the search at.
wrap bool Whether to continue the search from the beginning when it reaches the end of the subtitles.
backwards bool Whether to search backwards. Note that regex must be constructed with the /// option for backwards search to work.
return SubLib.Core.Domain

SubtitleSearchOptions() public method

Creates a new instance of the SubtitleSearchOptions class.
public SubtitleSearchOptions ( Regex regex, SubtitleTextType textType, string lineBreak, int startSubtitle, int startIndex, bool wrap, bool backwards ) : SubLib.Core.Domain
regex System.Text.RegularExpressions.Regex The regular expression to use when searching. It must be created with /// to perform a case-insensitive search.
textType SubtitleTextType The type of text content the search is started at.
lineBreak string The line break to use between multiple lines of text in each subtitle.
startSubtitle int The zero-based number of the subtitle to start the search at.
startIndex int The zero-based position within the startSubtitle to start the search at.
wrap bool Whether to continue the search from the beginning when it reaches the end of the subtitles.
backwards bool Whether to search backwards. Note that regex must be constructed with the /// option for backwards search to work.
return SubLib.Core.Domain