New-HTMLTable -HideButtons

[xlrod]

Good afternoon,

I'm not sure if this was already implemented and I just didn't find the option, but here is a way to hide all the buttons from the DataTable.

Added a switch parameter to the New-HTMLTable, -HideButtons.
I was going to use the code from the DataTables site buttons().disable(), but just added the switch to only add the buttons to the $Options hash if it's $False.

$Table = Get-Process | Select-Object -First 4

New-HTML -TitleText "Testing HideButtons" -FilePath "$PSScriptRoot\Test-HideButtons.html"  {
    # Hide
    New-HTMLSection -HeaderText "Hide Buttons" -Content {
        New-HTMLTable -DataTable $Table -HideButtons
    }
    # Show
    New-HTMLSection -HeaderText "Show Buttons" -Content {
        New-HTMLTable -DataTable $Table
    }
}

[PrzemyslawKlys]

-Buttons @() should do the trick. By default:

[string[]][ValidateSet('copyHtml5', 'excelHtml5', 'csvHtml5', 'pdfHtml5', 'pageLength')] $Buttons = @('copyHtml5', 'excelHtml5', 'csvHtml5', 'pdfHtml5', 'pageLength'),

But if you force it to empty array it's going to remove all buttons :-)

[xlrod]

Ah, so this is how to do it, thanks!
Would a -HideButtons parameter still be useful or would this be the preferred way?

[PrzemyslawKlys]

This would double the code, leading to the same solution no? Sure it's an easy fix. Not sure really?

You would need to add parameter sets I guess? If -hidebuttons is set don't show -Buttons or similar. Otherwise someone may set buttons and use -hidebuttons. I guess it's not problem to have -HideButtons for easy use.

[PrzemyslawKlys]

We could also alias $DisableSearch with $HideSearch.

[xlrod]

What if we add none to the ValidateSet of $Buttons, then add if($Buttons -ne "none") to the else statement of the buttons hash.

#Hide using Buttons none
New-HTMLSection -HeaderText "Show Buttons" -Content {
    New-HTMLTable -DataTable $Table -Buttons none
}

[PrzemyslawKlys]

Buttons is an array. What happens if someone uses None and CSV?

[xlrod]

Then use -contains instead of -ne? I'm just thinking out loud.
What do you think would be a better approach?

[PrzemyslawKlys]

DisableButtons seems obvious. Lets do it this way. But make sure that buttons works ;-)

[xlrod]

I'll work on it, thanks.

[xlrod]

Changed the parameter to -DisableButtons and added a warning if the switch is active.
WARNING: The -DisableButtons parameter is active, buttons will not be displayed for this table.

[PrzemyslawKlys]

Not sure if a warning is needed. It may just confuse users. If they use -DisableButtons it will be clear for them. At some point, we should try to build parameter sets that exclude one another.

Also if buttons are disabled I believe we should disable adding export to excel, csv and other JS libraries. Not necessary to keep links or content so make sure to update that as well.

[xlrod]

Got it, I'm going to research this, thanks.

[PrzemyslawKlys]

@xlrod want to deliver this or should I take it over?

[xlrod]

Hello, I'm back on this.
Question, you mention that if -DisableButtons is in use, we should not load the JS libraries, but what if the user would like to disable the buttons for one table and do custom buttons for another, would disabling these libraries prevent the custom buttons from displaying at all?

[PrzemyslawKlys]

We're only changing status of feature to $true and never to $false.

PSWriteHTML/Public/New-HTMLTable.ps1

Lines 473 to 476 in 2dbd0ae

	$Script:HTMLSchema.Features.Jquery = $true
	$Script:HTMLSchema.Features.DataTables = $true
	$Script:HTMLSchema.Features.DataTablesPDF = $true
	$Script:HTMLSchema.Features.DataTablesExcel = $true

This allows you to not enable the libraries if it's not needed, but if one table requires it, it will get enabled. In this case, all you have to do is to make sure that if you check if HideButtons is enabled you simply don't set PDF/Excel to true.

    $Script:HTMLSchema.Features.DataTablesPDF = $true
    $Script:HTMLSchema.Features.DataTablesExcel = $true

Btw I think HideButtons will be better then DisableButtons (which can be alias if needed) because disable may give false information of what will happen.