Proposed OpenXmlReader methods

In order to make more succinct calling code, I’ve extended OpenXmlReader in my code with these helpers. I propose that something similar can be added to the library.

public T LoadCurrentElement<T>() where T : OpenXmlElement => (T)_reader.LoadCurrentElement();

public bool ElementTypeIs<T>() where T : OpenXmlElement => ElementType == typeof(T);

public bool ElementIs<T>(out T element) where T : OpenXmlElement
{
       element = null;

        if (ElementTypeIs<T>())
        {
            element = LoadCurrentElement<T>();
            return true;
       }

       return false;
}

ElementIs<T> plays nice with the new out semantics introduced in C# 7.0. Instead of this mess,

if (reader.ElementType == typeof(Paragraph))
{
    Paragraph p = (Paragraph)reader.LoadCurrentElement();
    // ...
}

the new methods provide a simplification

if (reader.ElementIs(out Paragraph p))
{
    // ...
}

Thoughts?

[igitur]

I’m just a spectator here, but it’s definitely something we could use in ClosedXML. Here’s a snippet of our current code:

else if (reader.ElementType == typeof(AutoFilter))
    LoadAutoFilter((AutoFilter)reader.LoadCurrentElement(), ws);
else if (reader.ElementType == typeof(SheetProtection))
    LoadSheetProtection((SheetProtection)reader.LoadCurrentElement(), ws);
else if (reader.ElementType == typeof(DataValidations))
    LoadDataValidations((DataValidations)reader.LoadCurrentElement(), ws);
else if (reader.ElementType == typeof(ConditionalFormatting))
    LoadConditionalFormatting((ConditionalFormatting)reader.LoadCurrentElement(), ws, differentialFormats);
else if (reader.ElementType == typeof(Hyperlinks))
    LoadHyperlinks((Hyperlinks)reader.LoadCurrentElement(), wsPart, ws);
else if (reader.ElementType == typeof(PrintOptions))
    LoadPrintOptions((PrintOptions)reader.LoadCurrentElement(), ws);
else if (reader.ElementType == typeof(PageMargins))
    LoadPageMargins((PageMargins)reader.LoadCurrentElement(), ws);
else if (reader.ElementType == typeof(PageSetup))
    LoadPageSetup((PageSetup)reader.LoadCurrentElement(), ws, pageSetupProperties);
else if (reader.ElementType == typeof(HeaderFooter))
    LoadHeaderFooter((HeaderFooter)reader.LoadCurrentElement(), ws);
else if (reader.ElementType == typeof(SheetProperties))
    LoadSheetProperties((SheetProperties)reader.LoadCurrentElement(), ws, out pageSetupProperties);
else if (reader.ElementType == typeof(RowBreaks))
    LoadRowBreaks((RowBreaks)reader.LoadCurrentElement(), ws);
else if (reader.ElementType == typeof(ColumnBreaks))
    LoadColumnBreaks((ColumnBreaks)reader.LoadCurrentElement(), ws);
else if (reader.ElementType == typeof(WorksheetExtensionList))
    LoadExtensions((WorksheetExtensionList)reader.LoadCurrentElement(), ws);
else if (reader.ElementType == typeof(LegacyDrawing))
    ws.LegacyDrawingId = (reader.LoadCurrentElement() as LegacyDrawing).Id.Value;

Looks like it is an ideal candidate for use of the proposed new methods.

[github-actions[bot]]

Stale issue message