Class Russian.BgnPcgn

The BGN/PCGN system of romanization for Russian.
It was developed by the Unites States Board on Geographic Names and the Permanent Committee on Geographical Names for British Official Use, and is designed to be easier for anglophones to pronounce.
For more information, visit: https://en.wikipedia.org/wiki/BGN/PCGN_romanization_of_Russian

Inheritance

System.Object

Russian.BgnPcgn

Implements

IMultiInCultureSystem

IRomanizationSystem

Namespace: Romanization

Assembly: Romanization.NET.dll

Syntax

public sealed class BgnPcgn : object, IMultiInCultureSystem, IRomanizationSystem

Constructors

| Improve this Doc View Source

BgnPcgn()

Instantiates a copy of the system to process romanizations.

Declaration

public BgnPcgn()

Properties

| Improve this Doc View Source

DefaultCulture

The default culture this system will go with for romanization if Process(String) is used.

Declaration

public CultureInfo DefaultCulture { get; }

Property Value

Type	Description
CultureInfo

| Improve this Doc View Source

Type

The type of the system - this is an important consideration depending on the purpose of romanizing the text.
For more information, visit: https://en.wikipedia.org/wiki/Romanization#Methods

Declaration

public SystemType Type { get; }

Property Value

Type	Description
SystemType

Methods

| Improve this Doc View Source

Process(String)

Performs romanization according to the BGN/PCGN system on the given text, using digraphs.

Declaration

public string Process(string text)

Parameters

Type	Name	Description
System.String	text	The text to romanize.

Returns

Type	Description
System.String	A romanized version of the text, leaving unrecognized characters untouched.

| Improve this Doc View Source

Process(String, CultureInfo)

Performs romanization according to the BGN/PCGN system on the given text.
Supports providing a specific nativeCulture to process with, as long as the country code is ru.

Declaration

public string Process(string text, CultureInfo nativeCulture)

Parameters

Type	Name	Description
System.String	text	The text to romanize.
CultureInfo	nativeCulture	The culture to use.

Returns

Type	Description
System.String	A romanized version of the text, leaving unrecognized characters untouched.

Exceptions

Type	Condition
IrrelevantCultureException	`nativeCulture` is irrelevant to the language/region.

| Improve this Doc View Source

Process(String, Boolean)

Performs romanization according to the BGN/PCGN system on the given text.

Declaration

public string Process(string text, bool useDigraphs)

Parameters

Type	Name	Description
System.String	text	The text to romanize.
System.Boolean	useDigraphs	Whether or not to insert special digraph combinations with interpunct characters (eg. `шч` -> `sh·ch`).

Returns

Type	Description
System.String	A romanized version of the text, leaving unrecognized characters untouched.

| Improve this Doc View Source

Process(String, Boolean, CultureInfo)

Performs romanization according to the BGN/PCGN system on the given text.
Supports providing a specific culture to process with, as long as the country code is ru.

Declaration

public string Process(string text, bool useDigraphs, CultureInfo culture)

Parameters

Type	Name	Description
System.String	text	The text to romanize.
System.Boolean	useDigraphs	Whether or not to insert special digraph combinations with interpunct characters (eg. `шч` -> `sh·ch`).
CultureInfo	culture	The culture to use.

Returns

Type	Description
System.String	A romanized version of the text, leaving unrecognized characters untouched.

Exceptions

Type	Condition
IrrelevantCultureException	`culture` is irrelevant to the language/region.

Implements

IMultiInCultureSystem

IRomanizationSystem